Skip to content

feat(codegen/golang): add an option to wrap query errors that includes query name #3876

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

Merged
kyleconroy merged 4 commits into from
Mar 30, 2025
Merged

feat(codegen/golang): add an option to wrap query errors that includes query name #3876

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1019343
feat(codegen/golang): add an option to wrap query errors that include…
andrewmbenton Mar 9, 2025
f220086
use queryretval template func to avoid rewriting test output
andrewmbenton Mar 9, 2025
37eb9ae
shorter error messages
andrewmbenton Mar 9, 2025
9aa551f
add more tests
andrewmbenton Mar 9, 2025
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
Prev Previous commit
Next Next commit
shorter error messages
  • Loading branch information
@andrewmbenton
andrewmbenton committed Mar 9, 2025
commit 37eb9aeb66104f2a0fbe03953ba7bdd4a3480d27
14 changes: 7 additions & 7 deletions internal/codegen/golang/templates/pgx/queryCode.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ func (q *Queries) {{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) ({{.Ret.De
err := row.Scan({{.Ret.Scan}})
{{- if $.WrapErrors}}
if err != nil {
err = fmt.Errorf("error executing query {{.MethodName}}: %w", err)
err = fmt.Errorf("query {{.MethodName}}: %w", err)
}
{{- end}}
return {{.Ret.ReturnName}}, err
Expand All @@ -57,7 +57,7 @@ func (q *Queries) {{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) ([]{{.Ret.
rows, err := q.db.Query(ctx, {{.ConstantName}}, {{.Arg.Params}})
{{- end}}
if err != nil {
return nil, {{if $.WrapErrors}}fmt.Errorf("error executing query {{.MethodName}}: %w", err){{else}}err{{end}}
return nil, {{if $.WrapErrors}}fmt.Errorf("query {{.MethodName}}: %w", err){{else}}err{{end}}
}
defer rows.Close()
{{- if $.EmitEmptySlices}}
Expand All @@ -68,12 +68,12 @@ func (q *Queries) {{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) ([]{{.Ret.
for rows.Next() {
var {{.Ret.Name}} {{.Ret.Type}}
if err := rows.Scan({{.Ret.Scan}}); err != nil {
return nil, {{if $.WrapErrors}}fmt.Errorf("error executing query {{.MethodName}}: %w", err){{else}}err{{end}}
return nil, {{if $.WrapErrors}}fmt.Errorf("query {{.MethodName}}: %w", err){{else}}err{{end}}
}
items = append(items, {{.Ret.ReturnName}})
}
if err := rows.Err(); err != nil {
return nil, {{if $.WrapErrors}}fmt.Errorf("error executing query {{.MethodName}}: %w", err){{else}}err{{end}}
return nil, {{if $.WrapErrors}}fmt.Errorf("query {{.MethodName}}: %w", err){{else}}err{{end}}
}
return items, nil
}
Expand All @@ -89,7 +89,7 @@ func (q *Queries) {{.MethodName}}(ctx context.Context, db DBTX, {{.Arg.Pair}}) e
func (q *Queries) {{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) error {
_, err := q.db.Exec(ctx, {{.ConstantName}}, {{.Arg.Params}})
{{- end}}
return {{if $.WrapErrors}}fmt.Errorf("error executing query {{.MethodName}}: %w", err){{else}}err{{end}}
return {{if $.WrapErrors}}fmt.Errorf("query {{.MethodName}}: %w", err){{else}}err{{end}}
}
{{end}}

Expand All @@ -104,7 +104,7 @@ func (q *Queries) {{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) (int64, er
result, err := q.db.Exec(ctx, {{.ConstantName}}, {{.Arg.Params}})
{{- end}}
if err != nil {
return 0, {{if $.WrapErrors}}fmt.Errorf("error executing query {{.MethodName}}: %w", err){{else}}err{{end}}
return 0, {{if $.WrapErrors}}fmt.Errorf("query {{.MethodName}}: %w", err){{else}}err{{end}}
}
return result.RowsAffected(), nil
}
Expand All @@ -122,7 +122,7 @@ func (q *Queries) {{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) (pgconn.Co
{{- end}}
{{- if $.WrapErrors}}
if err != nil {
err = fmt.Errorf("error executing query {{.MethodName}}: %w", err)
err = fmt.Errorf("query {{.MethodName}}: %w", err)
}
return result, err
{{- end}}
Expand Down
18 changes: 9 additions & 9 deletions internal/codegen/golang/templates/stdlib/queryCode.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ func (q *Queries) {{.MethodName}}(ctx context.Context, {{ dbarg }} {{.Arg.Pair}}
err := row.Scan({{.Ret.Scan}})
{{- if $.WrapErrors}}
if err != nil {
err = fmt.Errorf("error executing query {{.MethodName}}: %w", err)
err = fmt.Errorf("query {{.MethodName}}: %w", err)
}
{{- end}}
return {{.Ret.ReturnName}}, err
Expand All @@ -43,7 +43,7 @@ func (q *Queries) {{.MethodName}}(ctx context.Context, {{ dbarg }} {{.Arg.Pair}}
func (q *Queries) {{.MethodName}}(ctx context.Context, {{ dbarg }} {{.Arg.Pair}}) ([]{{.Ret.DefineType}}, error) {
{{- template "queryCodeStdExec" . }}
if err != nil {
return nil, {{if $.WrapErrors}}fmt.Errorf("error executing query {{.MethodName}}: %w", err){{else}}err{{end}}
return nil, {{if $.WrapErrors}}fmt.Errorf("query {{.MethodName}}: %w", err){{else}}err{{end}}
}
defer rows.Close()
{{- if $.EmitEmptySlices}}
Expand All @@ -54,15 +54,15 @@ func (q *Queries) {{.MethodName}}(ctx context.Context, {{ dbarg }} {{.Arg.Pair}}
for rows.Next() {
var {{.Ret.Name}} {{.Ret.Type}}
if err := rows.Scan({{.Ret.Scan}}); err != nil {
return nil, {{if $.WrapErrors}}fmt.Errorf("error executing query {{.MethodName}}: %w", err){{else}}err{{end}}
return nil, {{if $.WrapErrors}}fmt.Errorf("query {{.MethodName}}: %w", err){{else}}err{{end}}
}
items = append(items, {{.Ret.ReturnName}})
}
if err := rows.Close(); err != nil {
return nil, {{if $.WrapErrors}}fmt.Errorf("error executing query {{.MethodName}}: %w", err){{else}}err{{end}}
return nil, {{if $.WrapErrors}}fmt.Errorf("query {{.MethodName}}: %w", err){{else}}err{{end}}
}
if err := rows.Err(); err != nil {
return nil, {{if $.WrapErrors}}fmt.Errorf("error executing query {{.MethodName}}: %w", err){{else}}err{{end}}
return nil, {{if $.WrapErrors}}fmt.Errorf("query {{.MethodName}}: %w", err){{else}}err{{end}}
}
return items, nil
}
Expand All @@ -75,7 +75,7 @@ func (q *Queries) {{.MethodName}}(ctx context.Context, {{ dbarg }} {{.Arg.Pair}}
{{- template "queryCodeStdExec" . }}
{{- if $.WrapErrors}}
if err != nil {
err = fmt.Errorf("error executing query {{.MethodName}}: %w", err)
err = fmt.Errorf("query {{.MethodName}}: %w", err)
}
{{- end}}
return err
Expand All @@ -88,7 +88,7 @@ func (q *Queries) {{.MethodName}}(ctx context.Context, {{ dbarg }} {{.Arg.Pair}}
func (q *Queries) {{.MethodName}}(ctx context.Context, {{ dbarg }} {{.Arg.Pair}}) (int64, error) {
{{- template "queryCodeStdExec" . }}
if err != nil {
return 0, {{if $.WrapErrors}}fmt.Errorf("error executing query {{.MethodName}}: %w", err){{else}}err{{end}}
return 0, {{if $.WrapErrors}}fmt.Errorf("query {{.MethodName}}: %w", err){{else}}err{{end}}
}
return result.RowsAffected()
}
Expand All @@ -100,7 +100,7 @@ func (q *Queries) {{.MethodName}}(ctx context.Context, {{ dbarg }} {{.Arg.Pair}}
func (q *Queries) {{.MethodName}}(ctx context.Context, {{ dbarg }} {{.Arg.Pair}}) (int64, error) {
{{- template "queryCodeStdExec" . }}
if err != nil {
return 0, {{if $.WrapErrors}}fmt.Errorf("error executing query {{.MethodName}}: %w", err){{else}}err{{end}}
return 0, {{if $.WrapErrors}}fmt.Errorf("query {{.MethodName}}: %w", err){{else}}err{{end}}
}
return result.LastInsertId()
}
Expand All @@ -113,7 +113,7 @@ func (q *Queries) {{.MethodName}}(ctx context.Context, {{ dbarg }} {{.Arg.Pair}}
{{- template "queryCodeStdExec" . }}
{{- if $.WrapErrors}}
if err != nil {
err = fmt.Errorf("error executing query {{.MethodName}}: %w", err)
err = fmt.Errorf("query {{.MethodName}}: %w", err)
}
return result, err
{{- end}}
Expand Down
16 changes: 8 additions & 8 deletions internal/endtoend/testdata/wrap_errors/postgresql/pgx/db/query.sql.go
View file
Open in desktop

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