diff options
author | 2021-10-11 05:37:33 -0700 | |
---|---|---|
committer | 2021-10-11 14:37:33 +0200 | |
commit | 083099a9575f8b2fac22c1d4a51a9dd0e2201243 (patch) | |
tree | d1787aa544679c433f797d2313ce532250fe574f /internal/timeline | |
parent | Handle forwarded messages (#273) (diff) | |
download | gotosocial-083099a9575f8b2fac22c1d4a51a9dd0e2201243.tar.xz |
reference global logrus (#274)
* reference logrus' global logger instead of passing and storing a logger reference everywhere
* always directly use global logrus logger instead of referencing an instance
* test suites should also directly use the global logrus logger
* rename gin logging function to clarify that it's middleware
* correct comments which erroneously referenced removed logger parameter
* setting log level for tests now uses logrus' exported type instead of the string value, to guarantee error isn't possible
Diffstat (limited to 'internal/timeline')
-rw-r--r-- | internal/timeline/get.go | 4 | ||||
-rw-r--r-- | internal/timeline/get_test.go | 4 | ||||
-rw-r--r-- | internal/timeline/index.go | 2 | ||||
-rw-r--r-- | internal/timeline/index_test.go | 4 | ||||
-rw-r--r-- | internal/timeline/manager.go | 14 | ||||
-rw-r--r-- | internal/timeline/manager_test.go | 2 | ||||
-rw-r--r-- | internal/timeline/prepare.go | 4 | ||||
-rw-r--r-- | internal/timeline/remove.go | 4 | ||||
-rw-r--r-- | internal/timeline/timeline.go | 7 | ||||
-rw-r--r-- | internal/timeline/timeline_test.go | 2 |
10 files changed, 20 insertions, 27 deletions
diff --git a/internal/timeline/get.go b/internal/timeline/get.go index a00613dc0..e1ad5cc97 100644 --- a/internal/timeline/get.go +++ b/internal/timeline/get.go @@ -31,7 +31,7 @@ import ( const retries = 5 func (t *timeline) Get(ctx context.Context, amount int, maxID string, sinceID string, minID string, prepareNext bool) ([]*apimodel.Status, error) { - l := t.log.WithFields(logrus.Fields{ + l := logrus.WithFields(logrus.Fields{ "func": "Get", "accountID": t.accountID, "amount": amount, @@ -137,7 +137,7 @@ func (t *timeline) GetXFromTop(ctx context.Context, amount int) ([]*apimodel.Sta } func (t *timeline) GetXBehindID(ctx context.Context, amount int, behindID string, attempts *int) ([]*apimodel.Status, error) { - l := t.log.WithFields(logrus.Fields{ + l := logrus.WithFields(logrus.Fields{ "func": "GetXBehindID", "amount": amount, "behindID": behindID, diff --git a/internal/timeline/get_test.go b/internal/timeline/get_test.go index 6c4a58c76..22b2c5be8 100644 --- a/internal/timeline/get_test.go +++ b/internal/timeline/get_test.go @@ -40,13 +40,13 @@ func (suite *GetTestSuite) SetupSuite() { func (suite *GetTestSuite) SetupTest() { suite.config = testrig.NewTestConfig() suite.db = testrig.NewTestDB() - suite.log = testrig.NewTestLog() + testrig.InitTestLog() suite.tc = testrig.NewTestTypeConverter(suite.db) testrig.StandardDBSetup(suite.db, nil) // let's take local_account_1 as the timeline owner - tl, err := timeline.NewTimeline(context.Background(), suite.testAccounts["local_account_1"].ID, suite.db, suite.tc, suite.log) + tl, err := timeline.NewTimeline(context.Background(), suite.testAccounts["local_account_1"].ID, suite.db, suite.tc) if err != nil { suite.FailNow(err.Error()) } diff --git a/internal/timeline/index.go b/internal/timeline/index.go index 7d7dc8873..5cd60b16b 100644 --- a/internal/timeline/index.go +++ b/internal/timeline/index.go @@ -81,7 +81,7 @@ grabloop: } func (t *timeline) IndexBehind(ctx context.Context, statusID string, include bool, amount int) error { - l := t.log.WithFields(logrus.Fields{ + l := logrus.WithFields(logrus.Fields{ "func": "IndexBehind", "include": include, "amount": amount, diff --git a/internal/timeline/index_test.go b/internal/timeline/index_test.go index 2a6429b3e..681f7617b 100644 --- a/internal/timeline/index_test.go +++ b/internal/timeline/index_test.go @@ -41,13 +41,13 @@ func (suite *IndexTestSuite) SetupSuite() { func (suite *IndexTestSuite) SetupTest() { suite.config = testrig.NewTestConfig() suite.db = testrig.NewTestDB() - suite.log = testrig.NewTestLog() + testrig.InitTestLog() suite.tc = testrig.NewTestTypeConverter(suite.db) testrig.StandardDBSetup(suite.db, nil) // let's take local_account_1 as the timeline owner, and start with an empty timeline - tl, err := timeline.NewTimeline(context.Background(), suite.testAccounts["local_account_1"].ID, suite.db, suite.tc, suite.log) + tl, err := timeline.NewTimeline(context.Background(), suite.testAccounts["local_account_1"].ID, suite.db, suite.tc) if err != nil { suite.FailNow(err.Error()) } diff --git a/internal/timeline/manager.go b/internal/timeline/manager.go index 7f42e2f51..5d41d72a9 100644 --- a/internal/timeline/manager.go +++ b/internal/timeline/manager.go @@ -84,13 +84,12 @@ type Manager interface { } // NewManager returns a new timeline manager with the given database, typeconverter, config, and log. -func NewManager(db db.DB, tc typeutils.TypeConverter, config *config.Config, log *logrus.Logger) Manager { +func NewManager(db db.DB, tc typeutils.TypeConverter, config *config.Config) Manager { return &manager{ accountTimelines: sync.Map{}, db: db, tc: tc, config: config, - log: log, } } @@ -99,11 +98,10 @@ type manager struct { db db.DB tc typeutils.TypeConverter config *config.Config - log *logrus.Logger } func (m *manager) Ingest(ctx context.Context, status *gtsmodel.Status, timelineAccountID string) (bool, error) { - l := m.log.WithFields(logrus.Fields{ + l := logrus.WithFields(logrus.Fields{ "func": "Ingest", "timelineAccountID": timelineAccountID, "statusID": status.ID, @@ -119,7 +117,7 @@ func (m *manager) Ingest(ctx context.Context, status *gtsmodel.Status, timelineA } func (m *manager) IngestAndPrepare(ctx context.Context, status *gtsmodel.Status, timelineAccountID string) (bool, error) { - l := m.log.WithFields(logrus.Fields{ + l := logrus.WithFields(logrus.Fields{ "func": "IngestAndPrepare", "timelineAccountID": timelineAccountID, "statusID": status.ID, @@ -135,7 +133,7 @@ func (m *manager) IngestAndPrepare(ctx context.Context, status *gtsmodel.Status, } func (m *manager) Remove(ctx context.Context, timelineAccountID string, statusID string) (int, error) { - l := m.log.WithFields(logrus.Fields{ + l := logrus.WithFields(logrus.Fields{ "func": "Remove", "timelineAccountID": timelineAccountID, "statusID": statusID, @@ -151,7 +149,7 @@ func (m *manager) Remove(ctx context.Context, timelineAccountID string, statusID } func (m *manager) HomeTimeline(ctx context.Context, timelineAccountID string, maxID string, sinceID string, minID string, limit int, local bool) ([]*apimodel.Status, error) { - l := m.log.WithFields(logrus.Fields{ + l := logrus.WithFields(logrus.Fields{ "func": "HomeTimelineGet", "timelineAccountID": timelineAccountID, }) @@ -237,7 +235,7 @@ func (m *manager) getOrCreateTimeline(ctx context.Context, timelineAccountID str i, ok := m.accountTimelines.Load(timelineAccountID) if !ok { var err error - t, err = NewTimeline(ctx, timelineAccountID, m.db, m.tc, m.log) + t, err = NewTimeline(ctx, timelineAccountID, m.db, m.tc) if err != nil { return nil, err } diff --git a/internal/timeline/manager_test.go b/internal/timeline/manager_test.go index a67a8ae5a..072761cd7 100644 --- a/internal/timeline/manager_test.go +++ b/internal/timeline/manager_test.go @@ -38,7 +38,7 @@ func (suite *ManagerTestSuite) SetupSuite() { func (suite *ManagerTestSuite) SetupTest() { suite.config = testrig.NewTestConfig() suite.db = testrig.NewTestDB() - suite.log = testrig.NewTestLog() + testrig.InitTestLog() suite.tc = testrig.NewTestTypeConverter(suite.db) testrig.StandardDBSetup(suite.db, nil) diff --git a/internal/timeline/prepare.go b/internal/timeline/prepare.go index ee8175a5f..7e5a712e5 100644 --- a/internal/timeline/prepare.go +++ b/internal/timeline/prepare.go @@ -30,7 +30,7 @@ import ( ) func (t *timeline) prepareNextQuery(ctx context.Context, amount int, maxID string, sinceID string, minID string) error { - l := t.log.WithFields(logrus.Fields{ + l := logrus.WithFields(logrus.Fields{ "func": "prepareNextQuery", "amount": amount, "maxID": maxID, @@ -170,7 +170,7 @@ prepareloop: } func (t *timeline) PrepareFromTop(ctx context.Context, amount int) error { - l := t.log.WithFields(logrus.Fields{ + l := logrus.WithFields(logrus.Fields{ "func": "PrepareFromTop", "amount": amount, }) diff --git a/internal/timeline/remove.go b/internal/timeline/remove.go index 031dace1f..bd62ed8bc 100644 --- a/internal/timeline/remove.go +++ b/internal/timeline/remove.go @@ -27,7 +27,7 @@ import ( ) func (t *timeline) Remove(ctx context.Context, statusID string) (int, error) { - l := t.log.WithFields(logrus.Fields{ + l := logrus.WithFields(logrus.Fields{ "func": "Remove", "accountTimeline": t.accountID, "statusID": statusID, @@ -79,7 +79,7 @@ func (t *timeline) Remove(ctx context.Context, statusID string) (int, error) { } func (t *timeline) RemoveAllBy(ctx context.Context, accountID string) (int, error) { - l := t.log.WithFields(logrus.Fields{ + l := logrus.WithFields(logrus.Fields{ "func": "RemoveAllBy", "accountTimeline": t.accountID, "accountID": accountID, diff --git a/internal/timeline/timeline.go b/internal/timeline/timeline.go index 5f5fa1b4f..12c36a7f0 100644 --- a/internal/timeline/timeline.go +++ b/internal/timeline/timeline.go @@ -23,7 +23,6 @@ import ( "sync" "time" - "github.com/sirupsen/logrus" apimodel "github.com/superseriousbusiness/gotosocial/internal/api/model" "github.com/superseriousbusiness/gotosocial/internal/db" "github.com/superseriousbusiness/gotosocial/internal/gtsmodel" @@ -134,12 +133,11 @@ type timeline struct { db db.DB filter visibility.Filter tc typeutils.TypeConverter - log *logrus.Logger sync.Mutex } // NewTimeline returns a new Timeline for the given account ID -func NewTimeline(ctx context.Context, accountID string, db db.DB, typeConverter typeutils.TypeConverter, log *logrus.Logger) (Timeline, error) { +func NewTimeline(ctx context.Context, accountID string, db db.DB, typeConverter typeutils.TypeConverter) (Timeline, error) { timelineOwnerAccount := >smodel.Account{} if err := db.GetByID(ctx, accountID, timelineOwnerAccount); err != nil { return nil, err @@ -151,9 +149,8 @@ func NewTimeline(ctx context.Context, accountID string, db db.DB, typeConverter accountID: accountID, account: timelineOwnerAccount, db: db, - filter: visibility.NewFilter(db, log), + filter: visibility.NewFilter(db), tc: typeConverter, - log: log, }, nil } diff --git a/internal/timeline/timeline_test.go b/internal/timeline/timeline_test.go index 4f997cb1e..517575f3e 100644 --- a/internal/timeline/timeline_test.go +++ b/internal/timeline/timeline_test.go @@ -19,7 +19,6 @@ package timeline_test import ( - "github.com/sirupsen/logrus" "github.com/stretchr/testify/suite" "github.com/superseriousbusiness/gotosocial/internal/config" "github.com/superseriousbusiness/gotosocial/internal/db" @@ -32,7 +31,6 @@ type TimelineStandardTestSuite struct { suite.Suite config *config.Config db db.DB - log *logrus.Logger tc typeutils.TypeConverter testAccounts map[string]*gtsmodel.Account |