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.

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

prevent empty query to be executed #786

Merged
merged 1 commit into from
Sep 25, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions executors.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,16 @@ func (c *Connection) Reload(model interface{}) error {
})
}

// TODO: consider merging the following two methods.
sio4 marked this conversation as resolved.
Show resolved Hide resolved

// Exec runs the given query.
func (q *Query) Exec() error {
return q.Connection.timeFunc("Exec", func() error {
sql, args := q.ToSQL(nil)
if sql == "" {
return fmt.Errorf("empty query")
}

log(logging.SQL, sql, args...)
_, err := q.Connection.Store.Exec(sql, args...)
return err
Expand All @@ -36,6 +42,10 @@ func (q *Query) ExecWithCount() (int, error) {
count := int64(0)
return int(count), q.Connection.timeFunc("Exec", func() error {
sql, args := q.ToSQL(nil)
if sql == "" {
return fmt.Errorf("empty query")
}
sio4 marked this conversation as resolved.
Show resolved Hide resolved

log(logging.SQL, sql, args...)
result, err := q.Connection.Store.Exec(sql, args...)
if err != nil {
Expand Down
4 changes: 4 additions & 0 deletions query.go
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,10 @@ func Q(c *Connection) *Query {
// from the `Model` passed in.
func (q Query) ToSQL(model *Model, addColumns ...string) (string, []interface{}) {
sb := q.toSQLBuilder(model, addColumns...)
// nil model is allowed only when if RawSQL is provided.
if model == nil && (q.RawSQL == nil || q.RawSQL.Fragment == "") {
return "", nil
}
sio4 marked this conversation as resolved.
Show resolved Hide resolved
return sb.String(), sb.Args()
}

Expand Down
19 changes: 19 additions & 0 deletions query_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -386,3 +386,22 @@ func Test_ToSQL_RawQuery(t *testing.T) {
a.Equal(args, []interface{}{"random", "query"})
})
}

func Test_RawQuery_Empty(t *testing.T) {
Debug = true
defer func() { Debug = false }()

t.Run("EmptyQuery", func(t *testing.T) {
r := require.New(t)
transaction(func(tx *Connection) {
r.Error(tx.Q().Exec())
sio4 marked this conversation as resolved.
Show resolved Hide resolved
})
})

t.Run("EmptyRawQuery", func(t *testing.T) {
r := require.New(t)
transaction(func(tx *Connection) {
r.Error(tx.RawQuery("").Exec())
sio4 marked this conversation as resolved.
Show resolved Hide resolved
})
})
}
18 changes: 11 additions & 7 deletions sql_builder.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ type sqlBuilder struct {
AddColumns []string
sql string
args []interface{}
isCompiled bool
err error
}

func newSQLBuilder(q Query, m *Model, addColumns ...string) *sqlBuilder {
Expand All @@ -25,6 +27,7 @@ func newSQLBuilder(q Query, m *Model, addColumns ...string) *sqlBuilder {
Model: m,
AddColumns: addColumns,
args: []interface{}{},
isCompiled: false,
}
}

Expand Down Expand Up @@ -53,19 +56,15 @@ func hasLimitOrOffset(sqlString string) bool {
}

func (sq *sqlBuilder) String() string {
if sq.sql == "" {
if !sq.isCompiled {
sq.compile()
}
return sq.sql
}

func (sq *sqlBuilder) Args() []interface{} {
if len(sq.args) == 0 {
if len(sq.Query.RawSQL.Arguments) > 0 {
sq.args = sq.Query.RawSQL.Arguments
} else {
sq.compile()
}
if !sq.isCompiled {
sq.compile()
}
return sq.args
}
Expand All @@ -83,7 +82,12 @@ func (sq *sqlBuilder) compile() {
}
sq.sql = sq.Query.RawSQL.Fragment
}
sq.args = sq.Query.RawSQL.Arguments
} else {
if sq.Model == nil {
sq.err = fmt.Errorf("sqlBuilder.compile() called but no RawSQL and Model specified")
return
sio4 marked this conversation as resolved.
Show resolved Hide resolved
}
switch sq.Query.Operation {
case Select:
sq.sql = sq.buildSelectSQL()
Expand Down