Skip to content
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

Jump to bottom

fix(vet): Split vet messages out of codegen.proto #2511

Merged
merged 3 commits into from
Jul 25, 2023
Merged

fix(vet): Split vet messages out of codegen.proto #2511

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
835c9b7
fix(vet): Split vet messages out of codegen.proto
kyleconroy Jul 24, 2023
9e5a64c
Fix cel.Types
kyleconroy Jul 24, 2023
e30695e
Merge branch 'main' into kyle/proto-vet-package
kyleconroy Jul 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 25 additions & 23 deletions internal/cmd/vet.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import (
"github.com/kyleconroy/sqlc/internal/opts"
"github.com/kyleconroy/sqlc/internal/plugin"
"github.com/kyleconroy/sqlc/internal/shfmt"
"github.com/kyleconroy/sqlc/internal/vet"
)

var ErrFailedChecks = errors.New("failed checks")
Expand Down Expand Up @@ -76,22 +77,22 @@ func Vet(ctx context.Context, e Env, dir, filename string, stderr io.Writer) err
cel.StdLib(),
ext.Strings(ext.StringsVersion(1)),
cel.Types(
&plugin.VetConfig{},
&plugin.VetQuery{},
&plugin.PostgreSQLExplain{},
&plugin.MySQLExplain{},
&vet.Config{},
&vet.Query{},
&vet.PostgreSQL{},
&vet.MySQL{},
),
cel.Variable("query",
cel.ObjectType("plugin.VetQuery"),
cel.ObjectType("vet.Query"),
),
cel.Variable("config",
cel.ObjectType("plugin.VetConfig"),
cel.ObjectType("vet.Config"),
),
cel.Variable("postgresql",
cel.ObjectType("plugin.PostgreSQL"),
cel.ObjectType("vet.PostgreSQL"),
),
cel.Variable("mysql",
cel.ObjectType("plugin.MySQL"),
cel.ObjectType("vet.MySQL"),
),
)
if err != nil {
Expand Down Expand Up @@ -170,7 +171,7 @@ func (p *pgxConn) Prepare(ctx context.Context, name, query string) error {
}

func (p *pgxConn) Explain(ctx context.Context, query string, args ...*plugin.Parameter) (*vetEngineOutput, error) {
eQuery := "EXPLAIN (ANALYZE false, VERBOSE, COSTS, SETTINGS, BUFFERS, FORMAT JSON) "+query
eQuery := "EXPLAIN (ANALYZE false, VERBOSE, COSTS, SETTINGS, BUFFERS, FORMAT JSON) " + query
eArgs := make([]any, len(args))
row := p.c.QueryRow(ctx, eQuery, eArgs...)
var result []json.RawMessage
Expand All @@ -181,11 +182,11 @@ func (p *pgxConn) Explain(ctx context.Context, query string, args ...*plugin.Par
fmt.Println(eQuery)
fmt.Println(string(result[0]))
}
var explain plugin.PostgreSQLExplain
var explain vet.PostgreSQLExplain
if err := pjson.Unmarshal(result[0], &explain); err != nil {
return nil, err
}
return &vetEngineOutput{PostgreSQL: &plugin.PostgreSQL{Explain: &explain}}, nil
return &vetEngineOutput{PostgreSQL: &vet.PostgreSQL{Explain: &explain}}, nil
}

type dbPreparer struct {
Expand All @@ -207,7 +208,7 @@ type mysqlExplainer struct {
}

func (me *mysqlExplainer) Explain(ctx context.Context, query string, args ...*plugin.Parameter) (*vetEngineOutput, error) {
eQuery := "EXPLAIN FORMAT=JSON "+query
eQuery := "EXPLAIN FORMAT=JSON " + query
eArgs := make([]any, len(args))
row := me.QueryRowContext(ctx, eQuery, eArgs...)
var result json.RawMessage
Expand All @@ -218,14 +219,14 @@ func (me *mysqlExplainer) Explain(ctx context.Context, query string, args ...*pl
fmt.Println(eQuery)
fmt.Println(string(result))
}
var explain plugin.MySQLExplain
var explain vet.MySQLExplain
if err := pjson.Unmarshal(result, &explain); err != nil {
return nil, err
}
if explain.QueryBlock.Message != "" {
return nil, fmt.Errorf("mysql explain: %s", explain.QueryBlock.Message)
}
return &vetEngineOutput{MySQL: &plugin.MySQL{Explain: &explain}}, nil
return &vetEngineOutput{MySQL: &vet.MySQL{Explain: &explain}}, nil
}

type rule struct {
Expand Down Expand Up @@ -377,7 +378,8 @@ func (c *checker) checkSQL(ctx context.Context, s config.SQL) error {
}

// Get explain output for this query if we need it
_, pgsqlOK := evalMap["postgresql"]; _, mysqlOK := evalMap["mysql"]
_, pgsqlOK := evalMap["postgresql"]
_, mysqlOK := evalMap["mysql"]
if rule.NeedsExplain && !(pgsqlOK || mysqlOK) {
if expl == nil {
fmt.Fprintf(c.Stderr, "%s: %s: %s: error explaining query: database connection required\n", query.Filename, query.Name, name)
Expand Down Expand Up @@ -420,23 +422,23 @@ func (c *checker) checkSQL(ctx context.Context, s config.SQL) error {
return nil
}

func vetConfig(req *plugin.CodeGenRequest) *plugin.VetConfig {
return &plugin.VetConfig{
func vetConfig(req *plugin.CodeGenRequest) *vet.Config {
return &vet.Config{
Version: req.Settings.Version,
Engine: req.Settings.Engine,
Schema: req.Settings.Schema,
Queries: req.Settings.Queries,
}
}

func vetQuery(q *plugin.Query) *plugin.VetQuery {
var params []*plugin.VetParameter
func vetQuery(q *plugin.Query) *vet.Query {
var params []*vet.Parameter
for _, p := range q.Params {
params = append(params, &plugin.VetParameter{
params = append(params, &vet.Parameter{
Number: p.Number,
})
}
return &plugin.VetQuery{
return &vet.Query{
Sql: q.Text,
Name: q.Name,
Cmd: strings.TrimPrefix(":", q.Cmd),
Expand All @@ -445,6 +447,6 @@ func vetQuery(q *plugin.Query) *plugin.VetQuery {
}

type vetEngineOutput struct {
PostgreSQL *plugin.PostgreSQL
MySQL *plugin.MySQL
PostgreSQL *vet.PostgreSQL
MySQL *vet.MySQL
}
Loading
Loading