From 1582cf8bad94890a1957595a0fd51bb128941280 Mon Sep 17 00:00:00 2001 From: tobi <31960611+tsmethurst@users.noreply.github.com> Date: Thu, 26 Aug 2021 18:55:39 +0200 Subject: [PATCH] fix null returned session (#159) --- internal/db/bundb/session.go | 30 ++++++++---- internal/db/bundb/session_test.go | 77 ++++++++++++++++++++++++++++++ internal/db/session.go | 1 - internal/gtsmodel/routersession.go | 4 +- internal/router/session.go | 13 +---- 5 files changed, 103 insertions(+), 22 deletions(-) create mode 100644 internal/db/bundb/session_test.go diff --git a/internal/db/bundb/session.go b/internal/db/bundb/session.go index 87e20673d..55efd21d4 100644 --- a/internal/db/bundb/session.go +++ b/internal/db/bundb/session.go @@ -21,6 +21,7 @@ import ( "context" "crypto/rand" + "errors" "github.com/sirupsen/logrus" "github.com/superseriousbusiness/gotosocial/internal/config" @@ -37,21 +38,34 @@ type sessionDB struct { } func (s *sessionDB) GetSession(ctx context.Context) (*gtsmodel.RouterSession, db.Error) { - rs := new(gtsmodel.RouterSession) + rss := []*gtsmodel.RouterSession{} - q := s.conn. + _, err := s.conn. NewSelect(). - Model(rs). - Limit(1) + Model(&rss). + Limit(1). + Order("id DESC"). + Exec(ctx) + if err != nil { + return nil, processErrorResponse(err) + } - _, err := q.Exec(ctx) + if len(rss) <= 0 { + // no session created yet, so make one + return s.createSession(ctx) + } - err = processErrorResponse(err) + if len(rss) != 1 { + // we asked for 1 so we should get 1 + return nil, errors.New("more than 1 router session was returned") + } - return rs, err + // return the one session found + rs := rss[0] + return rs, nil } -func (s *sessionDB) CreateSession(ctx context.Context) (*gtsmodel.RouterSession, db.Error) { +func (s *sessionDB) createSession(ctx context.Context) (*gtsmodel.RouterSession, db.Error) { auth := make([]byte, 32) crypt := make([]byte, 32) diff --git a/internal/db/bundb/session_test.go b/internal/db/bundb/session_test.go new file mode 100644 index 000000000..0334fae7b --- /dev/null +++ b/internal/db/bundb/session_test.go @@ -0,0 +1,77 @@ +/* + GoToSocial + Copyright (C) 2021 GoToSocial Authors admin@gotosocial.org + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . +*/ + +package bundb_test + +import ( + "context" + "testing" + + "github.com/stretchr/testify/suite" + "github.com/superseriousbusiness/gotosocial/testrig" +) + +type SessionTestSuite struct { + BunDBStandardTestSuite +} + +func (suite *SessionTestSuite) SetupSuite() { + suite.testTokens = testrig.NewTestTokens() + suite.testClients = testrig.NewTestClients() + suite.testApplications = testrig.NewTestApplications() + suite.testUsers = testrig.NewTestUsers() + suite.testAccounts = testrig.NewTestAccounts() + suite.testAttachments = testrig.NewTestAttachments() + suite.testStatuses = testrig.NewTestStatuses() + suite.testTags = testrig.NewTestTags() + suite.testMentions = testrig.NewTestMentions() +} + +func (suite *SessionTestSuite) SetupTest() { + suite.config = testrig.NewTestConfig() + suite.db = testrig.NewTestDB() + suite.log = testrig.NewTestLog() + + testrig.StandardDBSetup(suite.db, suite.testAccounts) +} + +func (suite *SessionTestSuite) TearDownTest() { + testrig.StandardDBTeardown(suite.db) +} + +func (suite *SessionTestSuite) TestGetSession() { + session, err := suite.db.GetSession(context.Background()) + suite.NoError(err) + suite.NotNil(session) + suite.NotEmpty(session.Auth) + suite.NotEmpty(session.Crypt) + suite.NotEmpty(session.ID) + + // TODO -- the same session should be returned with consecutive selects + // right now there's an issue with bytea in bun, so uncomment this when that issue is fixed: https://github.com/uptrace/bun/issues/122 + // session2, err := suite.db.GetSession(context.Background()) + // suite.NoError(err) + // suite.NotNil(session2) + // suite.Equal(session.Auth, session2.Auth) + // suite.Equal(session.Crypt, session2.Crypt) + // suite.Equal(session.ID, session2.ID) +} + +func TestSessionTestSuite(t *testing.T) { + suite.Run(t, new(SessionTestSuite)) +} diff --git a/internal/db/session.go b/internal/db/session.go index ae13dccce..1a547b36b 100644 --- a/internal/db/session.go +++ b/internal/db/session.go @@ -27,5 +27,4 @@ // Session handles getting/creation of router sessions. type Session interface { GetSession(ctx context.Context) (*gtsmodel.RouterSession, Error) - CreateSession(ctx context.Context) (*gtsmodel.RouterSession, Error) } diff --git a/internal/gtsmodel/routersession.go b/internal/gtsmodel/routersession.go index 7f3bd85c3..fbc1c7768 100644 --- a/internal/gtsmodel/routersession.go +++ b/internal/gtsmodel/routersession.go @@ -21,6 +21,6 @@ // RouterSession is used to store and retrieve settings for a router session. type RouterSession struct { ID string `bun:"type:CHAR(26),pk,notnull"` - Auth []byte `bun:"type:bytea,notnull"` - Crypt []byte `bun:"type:bytea,notnull"` + Auth []byte `bun:"type:bytea,notnull,nullzero"` + Crypt []byte `bun:"type:bytea,notnull,nullzero"` } diff --git a/internal/router/session.go b/internal/router/session.go index 4359a8a60..a42f04bfb 100644 --- a/internal/router/session.go +++ b/internal/router/session.go @@ -47,18 +47,9 @@ func useSession(ctx context.Context, cfg *config.Config, sessionDB db.Session, e // check if we have a saved router session already rs, err := sessionDB.GetSession(ctx) if err != nil { - if err != db.ErrNoEntries { - // proper error occurred - return err - } - // no session saved so create a new one - rs, err = sessionDB.CreateSession(ctx) - if err != nil { - return err - } + return fmt.Errorf("error using session: %s", err) } - - if rs == nil { + if rs == nil || rs.Auth == nil || rs.Crypt == nil { return errors.New("router session was nil") }