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>
Этот коммит содержится в:
Jesse Hallam
2025-02-06 12:36:31 -04:00
коммит произвёл GitHub
родитель c4718e4542
Коммит 7d9521d783
6 изменённых файлов: 282 добавлений и 89 удалений

Просмотреть файл

@@ -24,11 +24,13 @@ import (
"github.com/mattermost/mattermost/server/public/shared/timezones"
"github.com/mattermost/mattermost/server/v8/channels/store"
"github.com/mattermost/mattermost/server/v8/channels/utils"
sq "github.com/mattermost/squirrel"
)
type SqlStore interface {
GetMaster() SqlXExecutor
DriverName() string
GetQueryPlaceholder() sq.PlaceholderFormat
}
type SqlXExecutor interface {
@@ -5766,6 +5768,7 @@ func (s ByChannelDisplayName) Len() int { return len(s) }
func (s ByChannelDisplayName) Swap(i, j int) {
s[i], s[j] = s[j], s[i]
}
func (s ByChannelDisplayName) Less(i, j int) bool {
if s[i].DisplayName != s[j].DisplayName {
return s[i].DisplayName < s[j].DisplayName

Просмотреть файл

@@ -7,6 +7,8 @@ import (
"testing"
"time"
sq "github.com/mattermost/squirrel"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/mattermost/mattermost/server/public/model"
@@ -14,13 +16,15 @@ import (
"github.com/mattermost/mattermost/server/v8/channels/store"
)
func TestStatusStore(t *testing.T, rctx request.CTX, ss store.Store) {
func TestStatusStore(t *testing.T, rctx request.CTX, ss store.Store, s SqlStore) {
t.Run("", func(t *testing.T) { testStatusStore(t, rctx, ss) })
t.Run("ActiveUserCount", func(t *testing.T) { testActiveUserCount(t, rctx, ss) })
t.Run("UpdateExpiredDNDStatuses", func(t *testing.T) { testUpdateExpiredDNDStatuses(t, rctx, ss) })
t.Run("Get", func(t *testing.T) { testStatusGet(t, rctx, ss, s) })
t.Run("GetByIds", func(t *testing.T) { testStatusGetByIds(t, rctx, ss, s) })
}
func testStatusStore(t *testing.T, rctx request.CTX, ss store.Store) {
func testStatusStore(t *testing.T, _ request.CTX, ss store.Store) {
status := &model.Status{UserId: model.NewId(), Status: model.StatusOnline, Manual: false, LastActivityAt: 0, ActiveChannel: ""}
require.NoError(t, ss.Status().SaveOrUpdate(status))
@@ -51,12 +55,19 @@ func testStatusStore(t *testing.T, rctx request.CTX, ss store.Store) {
}
func testActiveUserCount(t *testing.T, rctx request.CTX, ss store.Store) {
status := &model.Status{UserId: model.NewId(), Status: model.StatusOnline, Manual: false, LastActivityAt: model.GetMillis(), ActiveChannel: ""}
require.NoError(t, ss.Status().SaveOrUpdate(status))
status1 := &model.Status{UserId: model.NewId(), Status: model.StatusOnline, Manual: false, LastActivityAt: model.GetMillis(), ActiveChannel: ""}
require.NoError(t, ss.Status().SaveOrUpdate(status1))
count, err := ss.Status().GetTotalActiveUsersCount()
count1, err := ss.Status().GetTotalActiveUsersCount()
require.NoError(t, err)
require.True(t, count > 0, "expected count > 0, got %d", count)
assert.Greater(t, count1, int64(0))
status2 := &model.Status{UserId: model.NewId(), Status: model.StatusOnline, Manual: false, LastActivityAt: model.GetMillis(), ActiveChannel: ""}
require.NoError(t, ss.Status().SaveOrUpdate(status2))
count2, err := ss.Status().GetTotalActiveUsersCount()
require.NoError(t, err)
assert.Equal(t, count1+1, count2)
}
type ByUserId []*model.Status
@@ -68,8 +79,15 @@ func (s ByUserId) Less(i, j int) bool { return s[i].UserId < s[j].UserId }
func testUpdateExpiredDNDStatuses(t *testing.T, rctx request.CTX, ss store.Store) {
userID := NewTestID()
status := &model.Status{UserId: userID, Status: model.StatusDnd, Manual: true,
DNDEndTime: time.Now().Add(5 * time.Second).Unix(), PrevStatus: model.StatusOnline}
status := &model.Status{
UserId: userID,
Status: model.StatusDnd,
Manual: true,
LastActivityAt: time.Now().Unix(),
ActiveChannel: "channel-id",
DNDEndTime: time.Now().Add(5 * time.Second).Unix(),
PrevStatus: model.StatusOnline,
}
require.NoError(t, ss.Status().SaveOrUpdate(status))
time.Sleep(2 * time.Second)
@@ -87,9 +105,181 @@ func testUpdateExpiredDNDStatuses(t *testing.T, rctx request.CTX, ss store.Store
require.Len(t, statuses, 1)
updatedStatus := *statuses[0]
require.Equal(t, updatedStatus.UserId, userID)
require.Equal(t, updatedStatus.Status, model.StatusOnline)
require.Equal(t, updatedStatus.DNDEndTime, int64(0))
require.Equal(t, updatedStatus.PrevStatus, model.StatusDnd)
require.Equal(t, updatedStatus.Manual, false)
assert.Equal(t, updatedStatus.UserId, userID)
assert.Equal(t, updatedStatus.Status, model.StatusOnline)
assert.Equal(t, updatedStatus.Manual, false)
assert.Equal(t, updatedStatus.LastActivityAt, updatedStatus.LastActivityAt)
assert.Empty(t, updatedStatus.ActiveChannel)
assert.Equal(t, updatedStatus.DNDEndTime, int64(0))
assert.Equal(t, updatedStatus.PrevStatus, model.StatusDnd)
}
func insertNullStatus(t *testing.T, ss store.Store, s SqlStore) string {
userId := model.NewId()
db := ss.GetInternalMasterDB()
// Insert status with explicit NULL values
builder := sq.StatementBuilder.PlaceholderFormat(s.GetQueryPlaceholder()).
Insert("Status").
Columns("UserId", "Status", quoteColumnName(s.DriverName(), "Manual"), "LastActivityAt", "DNDEndTime", "PrevStatus").
Values(userId, nil, nil, nil, nil, nil)
query, args, err := builder.ToSql()
require.NoError(t, err)
_, err = db.Exec(query, args...)
require.NoError(t, err)
return userId
}
func testStatusGet(t *testing.T, _ request.CTX, ss store.Store, s SqlStore) {
t.Run("null columns", func(t *testing.T) {
userId := insertNullStatus(t, ss, s)
received, err := ss.Status().Get(userId)
require.NoError(t, err)
assert.Equal(t, userId, received.UserId)
assert.Empty(t, received.Status)
assert.False(t, received.Manual)
assert.Equal(t, int64(0), received.LastActivityAt)
assert.Empty(t, received.ActiveChannel)
assert.Equal(t, int64(0), received.DNDEndTime)
assert.Empty(t, received.PrevStatus)
})
t.Run("status1", func(t *testing.T) {
status1 := &model.Status{
UserId: model.NewId(),
Status: model.StatusDnd,
Manual: true,
LastActivityAt: 1234,
ActiveChannel: "channel-id",
DNDEndTime: model.GetMillis(),
PrevStatus: model.StatusOnline,
}
require.NoError(t, ss.Status().SaveOrUpdate(status1))
received, err := ss.Status().Get(status1.UserId)
require.NoError(t, err)
assert.Equal(t, status1.UserId, received.UserId)
assert.Equal(t, status1.Status, received.Status)
assert.Equal(t, status1.Manual, received.Manual)
assert.Equal(t, status1.LastActivityAt, received.LastActivityAt)
assert.Empty(t, received.ActiveChannel)
assert.Equal(t, status1.DNDEndTime, received.DNDEndTime)
assert.Equal(t, status1.PrevStatus, received.PrevStatus)
})
t.Run("status2", func(t *testing.T) {
status2 := &model.Status{
UserId: model.NewId(),
Status: model.StatusOffline,
Manual: false,
LastActivityAt: 12345,
ActiveChannel: "channel-id2",
DNDEndTime: model.GetMillis(),
PrevStatus: model.StatusAway,
}
require.NoError(t, ss.Status().SaveOrUpdate(status2))
received, err := ss.Status().Get(status2.UserId)
require.NoError(t, err)
assert.Equal(t, status2.UserId, received.UserId)
assert.Equal(t, status2.Status, received.Status)
assert.Equal(t, status2.Manual, received.Manual)
assert.Equal(t, status2.LastActivityAt, received.LastActivityAt)
assert.Empty(t, received.ActiveChannel)
assert.Equal(t, status2.DNDEndTime, received.DNDEndTime)
assert.Equal(t, status2.PrevStatus, received.PrevStatus)
})
}
func testStatusGetByIds(t *testing.T, _ request.CTX, ss store.Store, s SqlStore) {
t.Run("null columns, single user", func(t *testing.T) {
userId := insertNullStatus(t, ss, s)
received, err := ss.Status().GetByIds([]string{userId})
require.NoError(t, err)
require.Len(t, received, 1)
assert.Equal(t, userId, received[0].UserId)
assert.Empty(t, received[0].Status)
assert.False(t, received[0].Manual)
assert.Equal(t, int64(0), received[0].LastActivityAt)
assert.Empty(t, received[0].ActiveChannel)
assert.Equal(t, int64(0), received[0].DNDEndTime)
assert.Empty(t, received[0].PrevStatus)
})
t.Run("single user", func(t *testing.T) {
status1 := &model.Status{
UserId: model.NewId(),
Status: model.StatusDnd,
Manual: true,
LastActivityAt: 1234,
ActiveChannel: "channel-id",
DNDEndTime: model.GetMillis(),
PrevStatus: model.StatusOnline,
}
require.NoError(t, ss.Status().SaveOrUpdate(status1))
received, err := ss.Status().GetByIds([]string{status1.UserId})
require.NoError(t, err)
require.Len(t, received, 1)
assert.Equal(t, status1.UserId, received[0].UserId)
assert.Equal(t, status1.Status, received[0].Status)
assert.Equal(t, status1.Manual, received[0].Manual)
assert.Equal(t, status1.LastActivityAt, received[0].LastActivityAt)
assert.Empty(t, received[0].ActiveChannel)
assert.Equal(t, status1.DNDEndTime, received[0].DNDEndTime)
assert.Equal(t, status1.PrevStatus, received[0].PrevStatus)
})
t.Run("multiple users", func(t *testing.T) {
status1 := &model.Status{
UserId: model.NewId(),
Status: model.StatusDnd,
Manual: true,
LastActivityAt: 1234,
ActiveChannel: "channel-id",
DNDEndTime: model.GetMillis(),
PrevStatus: model.StatusOnline,
}
require.NoError(t, ss.Status().SaveOrUpdate(status1))
status2 := &model.Status{
UserId: model.NewId(),
Status: model.StatusOffline,
Manual: false,
LastActivityAt: 12345,
ActiveChannel: "channel-id2",
DNDEndTime: model.GetMillis(),
PrevStatus: model.StatusAway,
}
require.NoError(t, ss.Status().SaveOrUpdate(status2))
received, err := ss.Status().GetByIds([]string{status1.UserId, status2.UserId})
require.NoError(t, err)
require.Len(t, received, 2)
for _, status := range received {
if status.UserId == status1.UserId {
assert.Equal(t, status1.UserId, status.UserId)
assert.Equal(t, status1.Status, status.Status)
assert.Equal(t, status1.Manual, status.Manual)
assert.Equal(t, status1.LastActivityAt, status.LastActivityAt)
assert.Empty(t, status.ActiveChannel)
assert.Equal(t, status1.DNDEndTime, status.DNDEndTime)
assert.Equal(t, status1.PrevStatus, status.PrevStatus)
} else {
assert.Equal(t, status2.UserId, status.UserId)
assert.Equal(t, status2.Status, status.Status)
assert.Equal(t, status2.Manual, status.Manual)
assert.Equal(t, status2.LastActivityAt, status.LastActivityAt)
assert.Empty(t, status.ActiveChannel)
assert.Equal(t, status2.DNDEndTime, status.DNDEndTime)
assert.Equal(t, status2.PrevStatus, status.PrevStatus)
}
}
})
}

Просмотреть файл

@@ -4,6 +4,8 @@
package storetest
import (
"fmt"
"github.com/mattermost/mattermost/server/public/model"
)
@@ -19,3 +21,16 @@ func NewTestID() string {
return string(newID)
}
// Adds backtiks to the column name for MySQL, this is required if
// the column name is a reserved keyword.
//
// `ColumnName` - MySQL
// ColumnName - Postgres
func quoteColumnName(driver string, columnName string) string {
if driver == model.DatabaseDriverMysql {
return fmt.Sprintf("`%s`", columnName)
}
return columnName
}