Skip to content

Commit b61dc46

Browse files
kyleconroykyleconroy
authored
fix(opts): Validate SQL package and driver options (#3241)
1 parent 014d6fc commit b61dc46

21 files changed

Lines changed: 366 additions & 111 deletions

File tree

‎internal/codegen/golang/driver.go‎

Lines changed: 7 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,14 @@
11
package golang
22

3-
type SQLDriver string
3+
import "github.com/sqlc-dev/sqlc/internal/codegen/golang/opts"
44

5-
const (
6-
SQLPackagePGXV4 string = "pgx/v4"
7-
SQLPackagePGXV5 string = "pgx/v5"
8-
SQLPackageStandard string = "database/sql"
9-
)
10-
11-
const (
12-
SQLDriverPGXV4 SQLDriver = "github.com/jackc/pgx/v4"
13-
SQLDriverPGXV5 = "github.com/jackc/pgx/v5"
14-
SQLDriverLibPQ = "github.com/lib/pq"
15-
SQLDriverGoSQLDriverMySQL = "github.com/go-sql-driver/mysql"
16-
)
17-
18-
func parseDriver(sqlPackage string) SQLDriver {
5+
func parseDriver(sqlPackage string) opts.SQLDriver {
196
switch sqlPackage {
20-
case SQLPackagePGXV4:
21-
return SQLDriverPGXV4
22-
case SQLPackagePGXV5:
23-
return SQLDriverPGXV5
24-
default:
25-
return SQLDriverLibPQ
26-
}
27-
}
28-
29-
func (d SQLDriver) IsPGX() bool {
30-
return d == SQLDriverPGXV4 || d == SQLDriverPGXV5
31-
}
32-
33-
func (d SQLDriver) IsGoSQLDriverMySQL() bool {
34-
return d == SQLDriverGoSQLDriverMySQL
35-
}
36-
37-
func (d SQLDriver) Package() string {
38-
switch d {
39-
case SQLDriverPGXV4:
40-
return SQLPackagePGXV4
41-
case SQLDriverPGXV5:
42-
return SQLPackagePGXV5
7+
case opts.SQLPackagePGXV4:
8+
return opts.SQLDriverPGXV4
9+
case opts.SQLPackagePGXV5:
10+
return opts.SQLDriverPGXV5
4311
default:
44-
return SQLPackageStandard
12+
return opts.SQLDriverLibPQ
4513
}
4614
}

‎internal/codegen/golang/gen.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import (
1919
type tmplCtx struct {
2020
Q string
2121
Package string
22-
SQLDriver SQLDriver
22+
SQLDriver opts.SQLDriver
2323
Enums []Enum
2424
Structs []Struct
2525
GoQueries []Query
@@ -189,15 +189,15 @@ func generate(req *plugin.GenerateRequest, options *opts.Options, enums []Enum,
189189
OmitSqlcVersion: options.OmitSqlcVersion,
190190
}
191191

192-
if tctx.UsesCopyFrom && !tctx.SQLDriver.IsPGX() && options.SqlDriver != SQLDriverGoSQLDriverMySQL {
192+
if tctx.UsesCopyFrom && !tctx.SQLDriver.IsPGX() && options.SqlDriver != opts.SQLDriverGoSQLDriverMySQL {
193193
return nil, errors.New(":copyfrom is only supported by pgx and github.com/go-sql-driver/mysql")
194194
}
195195

196-
if tctx.UsesCopyFrom && options.SqlDriver == SQLDriverGoSQLDriverMySQL {
196+
if tctx.UsesCopyFrom && options.SqlDriver == opts.SQLDriverGoSQLDriverMySQL {
197197
if err := checkNoTimesForMySQLCopyFrom(queries); err != nil {
198198
return nil, err
199199
}
200-
tctx.SQLDriver = SQLDriverGoSQLDriverMySQL
200+
tctx.SQLDriver = opts.SQLDriverGoSQLDriverMySQL
201201
}
202202

203203
if tctx.UsesBatch && !tctx.SQLDriver.IsPGX() {

‎internal/codegen/golang/imports.go‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -126,10 +126,10 @@ func (i *importer) dbImports() fileImports {
126126

127127
sqlpkg := parseDriver(i.Options.SqlPackage)
128128
switch sqlpkg {
129-
case SQLDriverPGXV4:
129+
case opts.SQLDriverPGXV4:
130130
pkg = append(pkg, ImportSpec{Path: "github.com/jackc/pgconn"})
131131
pkg = append(pkg, ImportSpec{Path: "github.com/jackc/pgx/v4"})
132-
case SQLDriverPGXV5:
132+
case opts.SQLDriverPGXV5:
133133
pkg = append(pkg, ImportSpec{Path: "github.com/jackc/pgx/v5/pgconn"})
134134
pkg = append(pkg, ImportSpec{Path: "github.com/jackc/pgx/v5"})
135135
default:
@@ -172,9 +172,9 @@ func buildImports(options *opts.Options, queries []Query, uses func(string) bool
172172
for _, q := range queries {
173173
if q.Cmd == metadata.CmdExecResult {
174174
switch sqlpkg {
175-
case SQLDriverPGXV4:
175+
case opts.SQLDriverPGXV4:
176176
pkg[ImportSpec{Path: "github.com/jackc/pgconn"}] = struct{}{}
177-
case SQLDriverPGXV5:
177+
case opts.SQLDriverPGXV5:
178178
pkg[ImportSpec{Path: "github.com/jackc/pgx/v5/pgconn"}] = struct{}{}
179179
default:
180180
std["database/sql"] = struct{}{}
@@ -189,7 +189,7 @@ func buildImports(options *opts.Options, queries []Query, uses func(string) bool
189189
}
190190

191191
if uses("pgtype.") {
192-
if sqlpkg == SQLDriverPGXV5 {
192+
if sqlpkg == opts.SQLDriverPGXV5 {
193193
pkg[ImportSpec{Path: "github.com/jackc/pgx/v5/pgtype"}] = struct{}{}
194194
} else {
195195
pkg[ImportSpec{Path: "github.com/jackc/pgtype"}] = struct{}{}
@@ -429,7 +429,7 @@ func (i *importer) copyfromImports() fileImports {
429429
})
430430

431431
std["context"] = struct{}{}
432-
if i.Options.SqlDriver == SQLDriverGoSQLDriverMySQL {
432+
if i.Options.SqlDriver == opts.SQLDriverGoSQLDriverMySQL {
433433
std["io"] = struct{}{}
434434
std["fmt"] = struct{}{}
435435
std["sync/atomic"] = struct{}{}
@@ -481,9 +481,9 @@ func (i *importer) batchImports() fileImports {
481481
std["errors"] = struct{}{}
482482
sqlpkg := parseDriver(i.Options.SqlPackage)
483483
switch sqlpkg {
484-
case SQLDriverPGXV4:
484+
case opts.SQLDriverPGXV4:
485485
pkg[ImportSpec{Path: "github.com/jackc/pgx/v4"}] = struct{}{}
486-
case SQLDriverPGXV5:
486+
case opts.SQLDriverPGXV5:
487487
pkg[ImportSpec{Path: "github.com/jackc/pgx/v5"}] = struct{}{}
488488
}
489489

‎internal/codegen/golang/opts/enum.go‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
package opts
2+
3+
import "fmt"
4+
5+
type SQLDriver string
6+
7+
const (
8+
SQLPackagePGXV4 string = "pgx/v4"
9+
SQLPackagePGXV5 string = "pgx/v5"
10+
SQLPackageStandard string = "database/sql"
11+
)
12+
13+
var validPackages = map[string]struct{}{
14+
string(SQLPackagePGXV4): {},
15+
string(SQLPackagePGXV5): {},
16+
string(SQLPackageStandard): {},
17+
}
18+
19+
func validatePackage(sqlPackage string) error {
20+
if _, found := validPackages[sqlPackage]; !found {
21+
return fmt.Errorf("unknown SQL package: %s", sqlPackage)
22+
}
23+
return nil
24+
}
25+
26+
const (
27+
SQLDriverPGXV4 SQLDriver = "github.com/jackc/pgx/v4"
28+
SQLDriverPGXV5 = "github.com/jackc/pgx/v5"
29+
SQLDriverLibPQ = "github.com/lib/pq"
30+
SQLDriverGoSQLDriverMySQL = "github.com/go-sql-driver/mysql"
31+
)
32+
33+
var validDrivers = map[string]struct{}{
34+
string(SQLDriverPGXV4): {},
35+
string(SQLDriverPGXV5): {},
36+
string(SQLDriverLibPQ): {},
37+
string(SQLDriverGoSQLDriverMySQL): {},
38+
}
39+
40+
func validateDriver(sqlDriver string) error {
41+
if _, found := validDrivers[sqlDriver]; !found {
42+
return fmt.Errorf("unknown SQL driver: %s", sqlDriver)
43+
}
44+
return nil
45+
}
46+
47+
func (d SQLDriver) IsPGX() bool {
48+
return d == SQLDriverPGXV4 || d == SQLDriverPGXV5
49+
}
50+
51+
func (d SQLDriver) IsGoSQLDriverMySQL() bool {
52+
return d == SQLDriverGoSQLDriverMySQL
53+
}
54+
55+
func (d SQLDriver) Package() string {
56+
switch d {
57+
case SQLDriverPGXV4:
58+
return SQLPackagePGXV4
59+
case SQLDriverPGXV5:
60+
return SQLPackagePGXV5
61+
default:
62+
return SQLPackageStandard
63+
}
64+
}

‎internal/codegen/golang/opts/options.go‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,18 @@ func parseOpts(req *plugin.GenerateRequest) (*Options, error) {
9494
}
9595
}
9696

97+
if options.SqlPackage != "" {
98+
if err := validatePackage(options.SqlPackage); err != nil {
99+
return nil, fmt.Errorf("invalid options: %s", err)
100+
}
101+
}
102+
103+
if options.SqlDriver != "" {
104+
if err := validateDriver(options.SqlDriver); err != nil {
105+
return nil, fmt.Errorf("invalid options: %s", err)
106+
}
107+
}
108+
97109
if options.QueryParameterLimit == nil {
98110
options.QueryParameterLimit = new(int32)
99111
*options.QueryParameterLimit = 1

0 commit comments

Comments
 (0)