Skip to content

Commit 6fd9950

Browse files
kyleconroykyleconroy
authored
feat(cmd/vet): Add built-in db-prepare rule (#2396)
* feat(cmd/vet): Add built-in db-prepare rule Instead of always preparing a query when running vet, opt-in to doing it with the `db-prepare` rule. * Error if db-prepare is used when a database connection isn't available * namespace db-prepare
1 parent a0d5d93 commit 6fd9950

File tree

8 files changed

+102
-60
lines changed

8 files changed

+102
-60
lines changed

‎examples/authors/sqlc.json

Lines changed: 0 additions & 47 deletions
This file was deleted.

‎examples/authors/sqlc.yaml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
version: '2'
2+
sql:
3+
- schema: postgresql/schema.sql
4+
queries: postgresql/query.sql
5+
engine: postgresql
6+
database:
7+
url: postgresql://${PG_USER}:${PG_PASSWORD}@${PG_HOST}:${PG_PORT}/authors
8+
rules:
9+
- sqlc/db-prepare
10+
gen:
11+
go:
12+
package: authors
13+
out: postgresql
14+
- schema: mysql/schema.sql
15+
queries: mysql/query.sql
16+
engine: mysql
17+
database:
18+
url: root:${MYSQL_ROOT_PASSWORD}@tcp(${MYSQL_HOST}:${MYSQL_PORT})/authors?multiStatements=true&parseTime=true
19+
rules:
20+
- sqlc/db-prepare
21+
gen:
22+
go:
23+
package: authors
24+
out: mysql
25+
- schema: sqlite/schema.sql
26+
queries: sqlite/query.sql
27+
engine: sqlite
28+
database:
29+
url: file:authors?mode=memory&cache=shared
30+
rules:
31+
- sqlc/db-prepare
32+
gen:
33+
go:
34+
package: authors
35+
out: sqlite

‎examples/batch/sqlc.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@
1010
"database": {
1111
"url": "postgresql://${PG_USER}:${PG_PASSWORD}@${PG_HOST}:${PG_PORT}/batch"
1212
},
13+
"rules": [
14+
"sqlc/db-prepare"
15+
],
1316
"sql_package": "pgx/v4",
1417
"emit_json_tags": true,
1518
"emit_prepared_queries": true,

‎examples/booktest/sqlc.json

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@
99
"engine": "postgresql",
1010
"database": {
1111
"url": "postgresql://${PG_USER}:${PG_PASSWORD}@${PG_HOST}:${PG_PORT}/booktest"
12-
}
12+
},
13+
"rules": [
14+
"sqlc/db-prepare"
15+
]
1316
},
1417
{
1518
"name": "booktest",
@@ -19,7 +22,10 @@
1922
"engine": "mysql",
2023
"database": {
2124
"url": "root:${MYSQL_ROOT_PASSWORD}@tcp(${MYSQL_HOST}:${MYSQL_PORT})/booktest?multiStatements=true&parseTime=true"
22-
}
25+
},
26+
"rules": [
27+
"sqlc/db-prepare"
28+
]
2329
},
2430
{
2531
"name": "booktest",
@@ -29,7 +35,10 @@
2935
"engine": "sqlite",
3036
"database": {
3137
"url": "file:booktest?mode=memory&cache=shared"
32-
}
38+
},
39+
"rules": [
40+
"sqlc/db-prepare"
41+
]
3342
}
3443
]
3544
}

‎examples/jets/sqlc.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@
99
"engine": "postgresql",
1010
"database": {
1111
"url": "postgresql://${PG_USER}:${PG_PASSWORD}@${PG_HOST}:${PG_PORT}/jets"
12-
}
12+
},
13+
"rules": [
14+
"sqlc/db-prepare"
15+
]
1316
}
1417
]
1518
}

‎examples/ondeck/sqlc.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@
1010
"database": {
1111
"url": "postgresql://${PG_USER}:${PG_PASSWORD}@${PG_HOST}:${PG_PORT}/ondeck"
1212
},
13+
"rules": [
14+
"sqlc/db-prepare"
15+
],
1316
"emit_json_tags": true,
1417
"emit_prepared_queries": true,
1518
"emit_interface": true
@@ -23,6 +26,9 @@
2326
"database": {
2427
"url": "root:${MYSQL_ROOT_PASSWORD}@tcp(${MYSQL_HOST}:${MYSQL_PORT})/ondeck?multiStatements=true&parseTime=true"
2528
},
29+
"rules": [
30+
"sqlc/db-prepare"
31+
],
2632
"emit_json_tags": true,
2733
"emit_prepared_queries": true,
2834
"emit_interface": true
@@ -36,6 +42,9 @@
3642
"database": {
3743
"url": "file:ondeck?mode=memory&cache=shared"
3844
},
45+
"rules": [
46+
"sqlc/db-prepare"
47+
],
3948
"emit_json_tags": true,
4049
"emit_prepared_queries": true,
4150
"emit_interface": true

‎internal/cmd/vet.go

Lines changed: 35 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ import (
1414

1515
_ "github.com/go-sql-driver/mysql"
1616
"github.com/google/cel-go/cel"
17+
"github.com/google/cel-go/common/types/ref"
1718
"github.com/google/cel-go/ext"
1819
"github.com/jackc/pgx/v5"
1920
_ "github.com/mattn/go-sqlite3"
@@ -29,6 +30,8 @@ import (
2930

3031
var ErrFailedChecks = errors.New("failed checks")
3132

33+
const RuleDbPrepare = "sqlc/db-prepare"
34+
3235
func NewCmdVet() *cobra.Command {
3336
return &cobra.Command{
3437
Use: "vet",
@@ -48,6 +51,17 @@ func NewCmdVet() *cobra.Command {
4851
}
4952
}
5053

54+
type emptyProgram struct {
55+
}
56+
57+
func (e *emptyProgram) Eval(any) (ref.Val, *cel.EvalDetails, error) {
58+
return nil, nil, fmt.Errorf("unimplemented")
59+
}
60+
61+
func (e *emptyProgram) ContextEval(ctx context.Context, a any) (ref.Val, *cel.EvalDetails, error) {
62+
return e.Eval(a)
63+
}
64+
5165
func Vet(ctx context.Context, e Env, dir, filename string, stderr io.Writer) error {
5266
configPath, conf, err := readConfig(stderr, dir, filename)
5367
if err != nil {
@@ -83,7 +97,9 @@ func Vet(ctx context.Context, e Env, dir, filename string, stderr io.Writer) err
8397
return fmt.Errorf("new env: %s", err)
8498
}
8599

86-
checks := map[string]cel.Program{}
100+
checks := map[string]cel.Program{
101+
RuleDbPrepare: &emptyProgram{},
102+
}
87103
msgs := map[string]string{}
88104

89105
for _, c := range conf.Rules {
@@ -278,16 +294,26 @@ func (c *checker) checkSQL(ctx context.Context, s config.SQL) error {
278294
req := codeGenRequest(result, combo)
279295
cfg := vetConfig(req)
280296
for i, query := range req.Queries {
281-
original := result.Queries[i]
282-
if prep != nil && prepareable(s, original.RawStmt) {
283-
name := fmt.Sprintf("sqlc_vet_%d_%d", time.Now().Unix(), i)
284-
if err := prep.Prepare(ctx, name, query.Text); err != nil {
285-
fmt.Fprintf(c.Stderr, "%s: error preparing %s on %s: %s\n", query.Filename, query.Name, s.Engine, err)
286-
errored = true
287-
}
288-
}
289297
q := vetQuery(query)
290298
for _, name := range s.Rules {
299+
// Built-in rule
300+
if name == RuleDbPrepare {
301+
if prep == nil {
302+
fmt.Fprintf(c.Stderr, "%s: %s: %s: error preparing query: database connection required\n", query.Filename, q.Name, name)
303+
errored = true
304+
continue
305+
}
306+
original := result.Queries[i]
307+
if prepareable(s, original.RawStmt) {
308+
name := fmt.Sprintf("sqlc_vet_%d_%d", time.Now().Unix(), i)
309+
if err := prep.Prepare(ctx, name, query.Text); err != nil {
310+
fmt.Fprintf(c.Stderr, "%s: %s: %s: error preparing query: %s\n", query.Filename, q.Name, name, err)
311+
errored = true
312+
}
313+
}
314+
continue
315+
}
316+
291317
prg, ok := c.Checks[name]
292318
if !ok {
293319
return fmt.Errorf("type-check error: a check with the name '%s' does not exist", name)

‎internal/config/v_one.go

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ type V1GenerateSettings struct {
1515
Packages []v1PackageSettings `json:"packages" yaml:"packages"`
1616
Overrides []Override `json:"overrides,omitempty" yaml:"overrides,omitempty"`
1717
Rename map[string]string `json:"rename,omitempty" yaml:"rename,omitempty"`
18+
Rules []Rule `json:"rules" yaml:"rules"`
1819
}
1920

2021
type v1PackageSettings struct {
@@ -51,6 +52,7 @@ type v1PackageSettings struct {
5152
StrictOrderBy *bool `json:"strict_order_by" yaml:"strict_order_by"`
5253
QueryParameterLimit *int32 `json:"query_parameter_limit,omitempty" yaml:"query_parameter_limit"`
5354
OmitUnusedStructs bool `json:"omit_unused_structs,omitempty" yaml:"omit_unused_structs"`
55+
Rules []string `json:"rules" yaml:"rules"`
5456
}
5557

5658
func v1ParseConfig(rd io.Reader) (Config, error) {
@@ -131,6 +133,7 @@ func (c *V1GenerateSettings) Translate() Config {
131133
Version: c.Version,
132134
Project: c.Project,
133135
Cloud: c.Cloud,
136+
Rules: c.Rules,
134137
}
135138

136139
for _, pkg := range c.Packages {
@@ -143,6 +146,7 @@ func (c *V1GenerateSettings) Translate() Config {
143146
Database: pkg.Database,
144147
Schema: pkg.Schema,
145148
Queries: pkg.Queries,
149+
Rules: pkg.Rules,
146150
Gen: SQLGen{
147151
Go: &SQLGo{
148152
EmitInterface: pkg.EmitInterface,

0 commit comments

Comments
 (0)