Skip to content

Commit

Permalink
fix null returned session (#159)
Browse files Browse the repository at this point in the history
  • Loading branch information
tsmethurst authored Aug 26, 2021
1 parent 2eefaa0 commit 1582cf8
Show file tree
Hide file tree
Showing 5 changed files with 103 additions and 22 deletions.
30 changes: 22 additions & 8 deletions internal/db/bundb/session.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ package bundb
import (
"context"
"crypto/rand"
"errors"

"github.com/sirupsen/logrus"
"github.com/superseriousbusiness/gotosocial/internal/config"
Expand All @@ -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)

Expand Down
77 changes: 77 additions & 0 deletions internal/db/bundb/session_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
/*
GoToSocial
Copyright (C) 2021 GoToSocial Authors [email protected]
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 <http://www.gnu.org/licenses/>.
*/

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))
}
1 change: 0 additions & 1 deletion internal/db/session.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,4 @@ import (
// Session handles getting/creation of router sessions.
type Session interface {
GetSession(ctx context.Context) (*gtsmodel.RouterSession, Error)
CreateSession(ctx context.Context) (*gtsmodel.RouterSession, Error)
}
4 changes: 2 additions & 2 deletions internal/gtsmodel/routersession.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ package gtsmodel
// 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"`
}
13 changes: 2 additions & 11 deletions internal/router/session.go
Original file line number Diff line number Diff line change
Expand Up @@ -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")
}

Expand Down

0 comments on commit 1582cf8

Please sign in to comment.