MM-62142: remove SELECT * from status store (round 2) (#30060)

* Revert "Revert "[MM-62142] Avoid SELECT * in status_store.go (#29610)" (#29985)"

This reverts commit d345e92136.

* add tests for StatusGet and StatusGetByIds

* handle NULL columns in the Status Store

* simplify status store

* more builder simplifications and tests

* expose GetQueryPlaceholder

---------

Co-authored-by: Mattermost Build <build@mattermost.com>

server/channels/store/sqlstore/sqlx_wrapper.go

@@ -20,6 +20,7 @@ import (
 	"github.com/mattermost/mattermost/server/public/model"
 	"github.com/mattermost/mattermost/server/public/shared/mlog"
 	"github.com/mattermost/mattermost/server/v8/channels/store/storetest"
+	sq "github.com/mattermost/squirrel"
 )
 
 type StoreTestWrapper struct {
@@ -38,6 +39,10 @@ func (w *StoreTestWrapper) DriverName() string {
 	return w.orig.DriverName()
 }
 
+func (w *StoreTestWrapper) GetQueryPlaceholder() sq.PlaceholderFormat {
+	return w.orig.getQueryPlaceholder()
+}
+
 type Builder interface {
 	ToSql() (string, []any, error)
 }

server/channels/store/sqlstore/status_store.go

@@ -17,10 +17,28 @@ import (
 
 type SqlStatusStore struct {
 	*SqlStore
+
+	statusSelectQuery sq.SelectBuilder
 }
 
 func newSqlStatusStore(sqlStore *SqlStore) store.StatusStore {
-	return &SqlStatusStore{sqlStore}
+	s := SqlStatusStore{
+		SqlStore: sqlStore,
+	}
+
+	manualColumnName := quoteColumnName(s.DriverName(), "Manual")
+	s.statusSelectQuery = s.getQueryBuilder().
+		Select(
+			"COALESCE(UserId, '') AS UserId",
+			"COALESCE(Status, '') AS Status",
+			fmt.Sprintf("COALESCE(%s, FALSE) AS %s", manualColumnName, manualColumnName),
+			"COALESCE(LastActivityAt, 0) AS LastActivityAt",
+			"COALESCE(DNDEndTime, 0) AS DNDEndTime",
+			"COALESCE(PrevStatus, '') AS PrevStatus",
+		).
+		From("Status")
+
+	return &s
 }
 
 func (s SqlStatusStore) SaveOrUpdate(st *model.Status) error {
@@ -37,12 +55,7 @@ func (s SqlStatusStore) SaveOrUpdate(st *model.Status) error {
 			st.Status, st.Manual, st.LastActivityAt, st.DNDEndTime, st.PrevStatus))
 	}
 
-	queryString, args, err := query.ToSql()
-	if err != nil {
-		return errors.Wrap(err, "status_tosql")
-	}
-
-	if _, err := s.GetMaster().Exec(queryString, args...); err != nil {
+	if _, err := s.GetMaster().ExecBuilder(query); err != nil {
 		return errors.Wrap(err, "failed to upsert Status")
 	}
 
@@ -50,9 +63,10 @@ func (s SqlStatusStore) SaveOrUpdate(st *model.Status) error {
 }
 
 func (s SqlStatusStore) Get(userId string) (*model.Status, error) {
-	var status model.Status
+	query := s.statusSelectQuery.Where(sq.Eq{"UserId": userId})
 
-	if err := s.GetReplica().Get(&status, "SELECT * FROM Status WHERE UserId = ?", userId); err != nil {
+	var status model.Status
+	if err := s.GetReplica().GetBuilder(&status, query); err != nil {
 		if err == sql.ErrNoRows {
 			return nil, store.NewErrNotFound("Status", fmt.Sprintf("userId=%s", userId))
 		}
@@ -62,30 +76,13 @@ func (s SqlStatusStore) Get(userId string) (*model.Status, error) {
 }
 
 func (s SqlStatusStore) GetByIds(userIds []string) ([]*model.Status, error) {
-	query := s.getQueryBuilder().
-		Select(fmt.Sprintf("UserId, Status, %s, LastActivityAt", quoteColumnName(s.DriverName(), "Manual"))).
-		From("Status").
-		Where(sq.Eq{"UserId": userIds})
-	queryString, args, err := query.ToSql()
-	if err != nil {
-		return nil, errors.Wrap(err, "status_tosql")
-	}
-	rows, err := s.GetReplica().DB.Query(queryString, args...)
+	query := s.statusSelectQuery.Where(sq.Eq{"UserId": userIds})
+
+	statuses := []*model.Status{}
+	err := s.GetReplica().SelectBuilder(&statuses, query)
 	if err != nil {
 		return nil, errors.Wrap(err, "failed to find Statuses")
 	}
-	statuses := []*model.Status{}
-	defer rows.Close()
-	for rows.Next() {
-		var status model.Status
-		if err = rows.Scan(&status.UserId, &status.Status, &status.Manual, &status.LastActivityAt); err != nil {
-			return nil, errors.Wrap(err, "unable to scan from rows")
-		}
-		statuses = append(statuses, &status)
-	}
-	if err = rows.Err(); err != nil {
-		return nil, errors.Wrap(err, "failed while iterating over rows")
-	}
 
 	return statuses, nil
 }
@@ -94,24 +91,19 @@ func (s SqlStatusStore) GetByIds(userIds []string) ([]*model.Status, error) {
 func (s SqlStatusStore) updateExpiredStatuses(t *sqlxTxWrapper) ([]*model.Status, error) {
 	statuses := []*model.Status{}
 	currUnixTime := time.Now().UTC().Unix()
-	selectQuery, selectParams, err := s.getQueryBuilder().
-		Select("*").
-		From("Status").
-		Where(
-			sq.And{
-				sq.Eq{"Status": model.StatusDnd},
-				sq.Gt{"DNDEndTime": 0},
-				sq.LtOrEq{"DNDEndTime": currUnixTime},
-			},
-		).ToSql()
-	if err != nil {
-		return nil, errors.Wrap(err, "status_tosql")
-	}
-	err = t.Select(&statuses, selectQuery, selectParams...)
+	selectQuery := s.statusSelectQuery.Where(
+		sq.And{
+			sq.Eq{"Status": model.StatusDnd},
+			sq.Gt{"DNDEndTime": 0},
+			sq.LtOrEq{"DNDEndTime": currUnixTime},
+		},
+	)
+
+	err := t.SelectBuilder(&statuses, selectQuery)
 	if err != nil {
 		return nil, errors.Wrap(err, "updateExpiredStatusesT: failed to get expired dnd statuses")
 	}
-	updateQuery, args, err := s.getQueryBuilder().
+	updateQuery := s.getQueryBuilder().
 		Update("Status").
 		Where(
 			sq.And{
@@ -123,14 +115,9 @@ func (s SqlStatusStore) updateExpiredStatuses(t *sqlxTxWrapper) ([]*model.Status
 		Set("Status", sq.Expr("PrevStatus")).
 		Set("PrevStatus", model.StatusDnd).
 		Set("DNDEndTime", 0).
-		Set(quoteColumnName(s.DriverName(), "Manual"), false).
-		ToSql()
+		Set(quoteColumnName(s.DriverName(), "Manual"), false)
 
-	if err != nil {
-		return nil, errors.Wrap(err, "status_tosql")
-	}
-
-	if _, err := t.Exec(updateQuery, args...); err != nil {
+	if _, err := t.ExecBuilder(updateQuery); err != nil {
 		return nil, errors.Wrapf(err, "updateExpiredStatusesT: failed to update statuses")
 	}
 
@@ -162,7 +149,7 @@ func (s SqlStatusStore) UpdateExpiredDNDStatuses() (_ []*model.Status, err error
 		return statuses, nil
 	}
 
-	queryString, args, err := s.getQueryBuilder().
+	queryString := s.getQueryBuilder().
 		Update("Status").
 		Where(
 			sq.And{
@@ -175,30 +162,13 @@ func (s SqlStatusStore) UpdateExpiredDNDStatuses() (_ []*model.Status, err error
 		Set("PrevStatus", model.StatusDnd).
 		Set("DNDEndTime", 0).
 		Set(quoteColumnName(s.DriverName(), "Manual"), false).
-		Suffix("RETURNING *").
-		ToSql()
+		Suffix("RETURNING *")
 
-	if err != nil {
-		return nil, errors.Wrap(err, "status_tosql")
-	}
-
-	rows, err := s.GetMaster().Query(queryString, args...)
+	statuses := []*model.Status{}
+	err = s.GetMaster().SelectBuilder(&statuses, queryString)
 	if err != nil {
 		return nil, errors.Wrap(err, "failed to find Statuses")
 	}
-	defer rows.Close()
-	statuses := []*model.Status{}
-	for rows.Next() {
-		var status model.Status
-		if err = rows.Scan(&status.UserId, &status.Status, &status.Manual, &status.LastActivityAt,
-			&status.DNDEndTime, &status.PrevStatus); err != nil {
-			return nil, errors.Wrap(err, "unable to scan from rows")
-		}
-		statuses = append(statuses, &status)
-	}
-	if err = rows.Err(); err != nil {
-		return nil, errors.Wrap(err, "failed while iterating over rows")
-	}
 
 	return statuses, nil
 }
@@ -212,8 +182,13 @@ func (s SqlStatusStore) ResetAll() error {
 
 func (s SqlStatusStore) GetTotalActiveUsersCount() (int64, error) {
 	time := model.GetMillis() - (1000 * 60 * 60 * 24)
+	query := s.getQueryBuilder().
+		Select("COUNT(UserId)").
+		From("Status").
+		Where(sq.Gt{"LastActivityAt": time})
+
 	var count int64
-	err := s.GetReplica().Get(&count, "SELECT COUNT(UserId) FROM Status WHERE LastActivityAt > ?", time)
+	err := s.GetReplica().GetBuilder(&count, query)
 	if err != nil {
 		return count, errors.Wrap(err, "failed to count active users")
 	}
@@ -221,7 +196,12 @@ func (s SqlStatusStore) GetTotalActiveUsersCount() (int64, error) {
 }
 
 func (s SqlStatusStore) UpdateLastActivityAt(userId string, lastActivityAt int64) error {
-	if _, err := s.GetMaster().Exec("UPDATE Status SET LastActivityAt = ? WHERE UserId = ?", lastActivityAt, userId); err != nil {
+	builder := s.getQueryBuilder().
+		Update("Status").
+		Set("LastActivityAt", lastActivityAt).
+		Where(sq.Eq{"UserId": userId})
+
+	if _, err := s.GetMaster().ExecBuilder(builder); err != nil {
 		return errors.Wrapf(err, "failed to update last activity for userId=%s", userId)
 	}
 

server/channels/store/sqlstore/status_store_test.go

@@ -10,5 +10,5 @@ import (
 )
 
 func TestStatusStore(t *testing.T) {
-	StoreTest(t, storetest.TestStatusStore)
+	StoreTestWithSqlStore(t, storetest.TestStatusStore)
 }