IntenseWebs/mattermost
3
0
Fork 0
mirror of https://github.com/mattermost/mattermost.git synced 2025-02-25 18:55:24 -06:00
Code Issues Packages Projects Releases Wiki Activity

Improve session cleanup (#18123)

Browse Source 
- We move logging statements to the upper layer.
Store functions are low-level methods and should return error
upwards rather than logging.
- Used IN instead of any (array ()) which is equivalent.
- Made the delay to be of type time.Duration and un-exported it.
- Unexported the batch size constant.

```release-note
NONE
```
This commit is contained in:
Agniva De Sarker
2021-08-13 20:15:24 +05:30
committed by GitHub
parent 2711262729
commit d1b164ab1f
8 changed files with 55 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
app/server.go
View File

@@ -1511,11 +1511,15 @@ func doCommandWebhookCleanup(s *Server) {
}
const (
SessionsCleanupBatchSize = 1000
sessionsCleanupBatchSize = 1000
)
func doSessionCleanup(s *Server) {
s.Store.Session().Cleanup(model.GetMillis(), SessionsCleanupBatchSize)
mlog.Debug("Cleaning up session store.")
err := s.Store.Session().Cleanup(model.GetMillis(), sessionsCleanupBatchSize)
if err != nil {
mlog.Warn("Error while cleaning up sessions", mlog.Err(err))
}
}
func doCheckAdminSupportStatus(a *App, c *request.Context) {

9
store/opentracinglayer/opentracinglayer.go
View File

@@ -6955,7 +6955,7 @@ func (s *OpenTracingLayerSessionStore) AnalyticsSessionCount() (int64, error) {
return result, err
}
func (s *OpenTracingLayerSessionStore) Cleanup(expiryTime int64, batchSize int64) {
func (s *OpenTracingLayerSessionStore) Cleanup(expiryTime int64, batchSize int64) error {
origCtx := s.Root.Store.Context()
span, newCtx := tracing.StartSpanWithParentByContext(s.Root.Store.Context(), "SessionStore.Cleanup")
s.Root.Store.SetContext(newCtx)
@@ -6964,8 +6964,13 @@ func (s *OpenTracingLayerSessionStore) Cleanup(expiryTime int64, batchSize int64
}()
defer span.Finish()
s.SessionStore.Cleanup(expiryTime, batchSize)
err := s.SessionStore.Cleanup(expiryTime, batchSize)
if err != nil {
span.LogFields(spanlog.Error(err))
ext.Error.Set(span, true)
}
return err
}
func (s *OpenTracingLayerSessionStore) Get(ctx context.Context, sessionIDOrToken string) (*model.Session, error) {

18
store/retrylayer/retrylayer.go
View File

@@ -7550,9 +7550,23 @@ func (s *RetryLayerSessionStore) AnalyticsSessionCount() (int64, error) {
}
func (s *RetryLayerSessionStore) Cleanup(expiryTime int64, batchSize int64) {
func (s *RetryLayerSessionStore) Cleanup(expiryTime int64, batchSize int64) error {
s.SessionStore.Cleanup(expiryTime, batchSize)
tries := 0
for {
err := s.SessionStore.Cleanup(expiryTime, batchSize)
if err == nil {
return nil
}
if !isRepeatableError(err) {
return err
}
tries++
if tries >= 3 {
err = errors.Wrap(err, "giving up after 3 consecutive repeatable transaction failures")
return err
}
}
}

19
store/sqlstore/session_store.go
View File

@@ -12,12 +12,11 @@ import (
"github.com/pkg/errors"
"github.com/mattermost/mattermost-server/v6/model"
"github.com/mattermost/mattermost-server/v6/shared/mlog"
"github.com/mattermost/mattermost-server/v6/store"
)
const (
SessionsCleanupDelayMilliseconds = 100
sessionsCleanupDelay = 100 * time.Millisecond
)
type SqlSessionStore struct {
@@ -275,12 +274,10 @@ func (me SqlSessionStore) AnalyticsSessionCount() (int64, error) {
return count, nil
}
func (me SqlSessionStore) Cleanup(expiryTime int64, batchSize int64) {
mlog.Debug("Cleaning up session store.")
func (me SqlSessionStore) Cleanup(expiryTime int64, batchSize int64) error {
var query string
if me.DriverName() == model.DatabaseDriverPostgres {
query = "DELETE FROM Sessions WHERE Id = any (array (SELECT Id FROM Sessions WHERE ExpiresAt != 0 AND :ExpiresAt > ExpiresAt LIMIT :Limit))"
query = "DELETE FROM Sessions WHERE Id IN (SELECT Id FROM Sessions WHERE ExpiresAt != 0 AND :ExpiresAt > ExpiresAt LIMIT :Limit)"
} else {
query = "DELETE FROM Sessions WHERE ExpiresAt != 0 AND :ExpiresAt > ExpiresAt LIMIT :Limit"
}
@@ -290,16 +287,16 @@ func (me SqlSessionStore) Cleanup(expiryTime int64, batchSize int64) {
for rowsAffected > 0 {
sqlResult, err := me.GetMaster().Exec(query, map[string]interface{}{"ExpiresAt": expiryTime, "Limit": batchSize})
if err != nil {
mlog.Error("Unable to cleanup session store.", mlog.Err(err))
return
return errors.Wrap(err, "unable to delete sessions")
}
var rowErr error
rowsAffected, rowErr = sqlResult.RowsAffected()
if rowErr != nil {
mlog.Error("Unable to cleanup session store.", mlog.Err(err))
return
return errors.Wrap(err, "unable to delete sessions")
}
time.Sleep(SessionsCleanupDelayMilliseconds * time.Millisecond)
time.Sleep(sessionsCleanupDelay)
}
return nil
}

2
store/store.go
View File

@@ -451,7 +451,7 @@ type SessionStore interface {
UpdateDeviceId(id string, deviceID string, expiresAt int64) (string, error)
UpdateProps(session *model.Session) error
AnalyticsSessionCount() (int64, error)
Cleanup(expiryTime int64, batchSize int64)
Cleanup(expiryTime int64, batchSize int64) error
}
type AuditStore interface {

13
store/storetest/mocks/SessionStore.go
View File

@@ -38,8 +38,17 @@ func (_m *SessionStore) AnalyticsSessionCount() (int64, error) {
}
// Cleanup provides a mock function with given fields: expiryTime, batchSize
func (_m *SessionStore) Cleanup(expiryTime int64, batchSize int64) {
_m.Called(expiryTime, batchSize)
func (_m *SessionStore) Cleanup(expiryTime int64, batchSize int64) error {
ret := _m.Called(expiryTime, batchSize)
var r0 error
if rf, ok := ret.Get(0).(func(int64, int64) error); ok {
r0 = rf(expiryTime, batchSize)
} else {
r0 = ret.Error(0)
}
return r0
}
// Get provides a mock function with given fields: ctx, sessionIDOrToken

3
store/storetest/session_store.go
View File

@@ -303,7 +303,8 @@ func testSessionCleanup(t *testing.T, ss store.Store) {
s4, err = ss.Session().Save(s4)
require.NoError(t, err)
ss.Session().Cleanup(now, 1)
err = ss.Session().Cleanup(now, 1)
require.NoError(t, err)
_, err = ss.Session().Get(context.Background(), s1.Id)
assert.NoError(t, err)

7
store/timerlayer/timerlayer.go
View File

@@ -6281,19 +6281,20 @@ func (s *TimerLayerSessionStore) AnalyticsSessionCount() (int64, error) {
return result, err
}
func (s *TimerLayerSessionStore) Cleanup(expiryTime int64, batchSize int64) {
func (s *TimerLayerSessionStore) Cleanup(expiryTime int64, batchSize int64) error {
start := timemodule.Now()
s.SessionStore.Cleanup(expiryTime, batchSize)
err := s.SessionStore.Cleanup(expiryTime, batchSize)
elapsed := float64(timemodule.Since(start)) / float64(timemodule.Second)
if s.Root.Metrics != nil {
success := "false"
if true {
if err == nil {
success = "true"
}
s.Root.Metrics.ObserveStoreMethodDuration("SessionStore.Cleanup", success, elapsed)
}
return err
}
func (s *TimerLayerSessionStore) Get(ctx context.Context, sessionIDOrToken string) (*model.Session, error) {