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

18 files changed, 26 insertions, 29 deletions

diff --git a/internal/api/client/status/status.go b/internal/api/client/status/status.go
index dec6bebce..cf6687efb 100644
--- a/internal/api/client/status/status.go
+++ b/internal/api/client/status/status.go
@@ -19,11 +19,11 @@
 package status
 
 import (
+	"github.com/sirupsen/logrus"
 	"net/http"
 	"strings"
 
 	"github.com/gin-gonic/gin"
-	"github.com/sirupsen/logrus"
 	"github.com/superseriousbusiness/gotosocial/internal/api"
 	"github.com/superseriousbusiness/gotosocial/internal/config"
 	"github.com/superseriousbusiness/gotosocial/internal/processing"
@@ -76,15 +76,13 @@ const (
 type Module struct {
 	config    *config.Config
 	processor processing.Processor
-	log       *logrus.Logger
 }
 
 // New returns a new account module
-func New(config *config.Config, processor processing.Processor, log *logrus.Logger) api.ClientModule {
+func New(config *config.Config, processor processing.Processor) api.ClientModule {
 	return &Module{
 		config:    config,
 		processor: processor,
-		log:       log,
 	}
 }
 
@@ -109,7 +107,7 @@ func (m *Module) Route(r router.Router) error {
 
 // muxHandler is a little workaround to overcome the limitations of Gin
 func (m *Module) muxHandler(c *gin.Context) {
-	m.log.Debug("entering mux handler")
+	logrus.Debug("entering mux handler")
 	ru := c.Request.RequestURI
 
 	switch c.Request.Method {
diff --git a/internal/api/client/status/status_test.go b/internal/api/client/status/status_test.go
index 214a00790..0c0c391b5 100644
--- a/internal/api/client/status/status_test.go
+++ b/internal/api/client/status/status_test.go
@@ -20,7 +20,6 @@ package status_test
 
 import (
 	"git.iim.gay/grufwub/go-store/kv"
-	"github.com/sirupsen/logrus"
 	"github.com/stretchr/testify/suite"
 	"github.com/superseriousbusiness/gotosocial/internal/api/client/status"
 	"github.com/superseriousbusiness/gotosocial/internal/config"
@@ -37,7 +36,6 @@ type StatusStandardTestSuite struct {
 	suite.Suite
 	config    *config.Config
 	db        db.DB
-	log       *logrus.Logger
 	tc        typeutils.TypeConverter
 	federator federation.Federator
 	processor processing.Processor
diff --git a/internal/api/client/status/statusboost.go b/internal/api/client/status/statusboost.go
index 6a1ccde28..bc950d358 100644
--- a/internal/api/client/status/statusboost.go
+++ b/internal/api/client/status/statusboost.go
@@ -66,7 +66,7 @@ import (
 //   '404':
 //      description: not found
 func (m *Module) StatusBoostPOSTHandler(c *gin.Context) {
-	l := m.log.WithFields(logrus.Fields{
+	l := logrus.WithFields(logrus.Fields{
 		"func":        "StatusBoostPOSTHandler",
 		"request_uri": c.Request.RequestURI,
 		"user_agent":  c.Request.UserAgent(),
diff --git a/internal/api/client/status/statusboost_test.go b/internal/api/client/status/statusboost_test.go
index 4157bde38..2a8db1f4d 100644
--- a/internal/api/client/status/statusboost_test.go
+++ b/internal/api/client/status/statusboost_test.go
@@ -51,10 +51,10 @@ func (suite *StatusBoostTestSuite) SetupTest() {
 	suite.config = testrig.NewTestConfig()
 	suite.db = testrig.NewTestDB()
 	suite.storage = testrig.NewTestStorage()
-	suite.log = testrig.NewTestLog()
+	testrig.InitTestLog()
 	suite.federator = testrig.NewTestFederator(suite.db, testrig.NewTestTransportController(testrig.NewMockHTTPClient(nil), suite.db), suite.storage)
 	suite.processor = testrig.NewTestProcessor(suite.db, suite.storage, suite.federator)
-	suite.statusModule = status.New(suite.config, suite.processor, suite.log).(*status.Module)
+	suite.statusModule = status.New(suite.config, suite.processor).(*status.Module)
 	testrig.StandardDBSetup(suite.db, nil)
 	testrig.StandardStorageSetup(suite.storage, "../../../../testrig/media")
 }
diff --git a/internal/api/client/status/statusboostedby.go b/internal/api/client/status/statusboostedby.go
index a1446aef7..79783dfb5 100644
--- a/internal/api/client/status/statusboostedby.go
+++ b/internal/api/client/status/statusboostedby.go
@@ -63,7 +63,7 @@ import (
 //   '404':
 //      description: not found
 func (m *Module) StatusBoostedByGETHandler(c *gin.Context) {
-	l := m.log.WithFields(logrus.Fields{
+	l := logrus.WithFields(logrus.Fields{
 		"func":        "StatusBoostedByGETHandler",
 		"request_uri": c.Request.RequestURI,
 		"user_agent":  c.Request.UserAgent(),
diff --git a/internal/api/client/status/statuscontext.go b/internal/api/client/status/statuscontext.go
index 90fcb9608..f9d7fcc35 100644
--- a/internal/api/client/status/statuscontext.go
+++ b/internal/api/client/status/statuscontext.go
@@ -65,7 +65,7 @@ import (
 //   '404':
 //      description: not found
 func (m *Module) StatusContextGETHandler(c *gin.Context) {
-	l := m.log.WithFields(logrus.Fields{
+	l := logrus.WithFields(logrus.Fields{
 		"func":        "StatusContextGETHandler",
 		"request_uri": c.Request.RequestURI,
 		"user_agent":  c.Request.UserAgent(),
diff --git a/internal/api/client/status/statuscreate.go b/internal/api/client/status/statuscreate.go
index cae11ebdb..e9d92890e 100644
--- a/internal/api/client/status/statuscreate.go
+++ b/internal/api/client/status/statuscreate.go
@@ -21,6 +21,7 @@ package status
 import (
 	"errors"
 	"fmt"
+	"github.com/sirupsen/logrus"
 	"net/http"
 
 	"github.com/gin-gonic/gin"
@@ -67,7 +68,7 @@ import (
 //   '500':
 //      description: internal error
 func (m *Module) StatusCreatePOSTHandler(c *gin.Context) {
-	l := m.log.WithField("func", "statusCreatePOSTHandler")
+	l := logrus.WithField("func", "statusCreatePOSTHandler")
 	authed, err := oauth.Authed(c, true, true, true, true) // posting a status is serious business so we want *everything*
 	if err != nil {
 		l.Debugf("couldn't auth: %s", err)
diff --git a/internal/api/client/status/statuscreate_test.go b/internal/api/client/status/statuscreate_test.go
index 084f1a6f4..e7c1125ce 100644
--- a/internal/api/client/status/statuscreate_test.go
+++ b/internal/api/client/status/statuscreate_test.go
@@ -57,11 +57,11 @@ func (suite *StatusCreateTestSuite) SetupTest() {
 	suite.config = testrig.NewTestConfig()
 	suite.db = testrig.NewTestDB()
 	suite.storage = testrig.NewTestStorage()
-	suite.log = testrig.NewTestLog()
+	testrig.InitTestLog()
 	suite.tc = testrig.NewTestTypeConverter(suite.db)
 	suite.federator = testrig.NewTestFederator(suite.db, testrig.NewTestTransportController(testrig.NewMockHTTPClient(nil), suite.db), suite.storage)
 	suite.processor = testrig.NewTestProcessor(suite.db, suite.storage, suite.federator)
-	suite.statusModule = status.New(suite.config, suite.processor, suite.log).(*status.Module)
+	suite.statusModule = status.New(suite.config, suite.processor).(*status.Module)
 	testrig.StandardDBSetup(suite.db, nil)
 	testrig.StandardStorageSetup(suite.storage, "../../../../testrig/media")
 }
diff --git a/internal/api/client/status/statusdelete.go b/internal/api/client/status/statusdelete.go
index 1914a1a07..5a6b2928e 100644
--- a/internal/api/client/status/statusdelete.go
+++ b/internal/api/client/status/statusdelete.go
@@ -65,7 +65,7 @@ import (
 //   '404':
 //      description: not found
 func (m *Module) StatusDELETEHandler(c *gin.Context) {
-	l := m.log.WithFields(logrus.Fields{
+	l := logrus.WithFields(logrus.Fields{
 		"func":        "StatusDELETEHandler",
 		"request_uri": c.Request.RequestURI,
 		"user_agent":  c.Request.UserAgent(),
diff --git a/internal/api/client/status/statusfave.go b/internal/api/client/status/statusfave.go
index 94d930989..7d4879832 100644
--- a/internal/api/client/status/statusfave.go
+++ b/internal/api/client/status/statusfave.go
@@ -62,7 +62,7 @@ import (
 //   '404':
 //      description: not found
 func (m *Module) StatusFavePOSTHandler(c *gin.Context) {
-	l := m.log.WithFields(logrus.Fields{
+	l := logrus.WithFields(logrus.Fields{
 		"func":        "StatusFavePOSTHandler",
 		"request_uri": c.Request.RequestURI,
 		"user_agent":  c.Request.UserAgent(),
diff --git a/internal/api/client/status/statusfave_test.go b/internal/api/client/status/statusfave_test.go
index 2f7a2c596..3fafe44e4 100644
--- a/internal/api/client/status/statusfave_test.go
+++ b/internal/api/client/status/statusfave_test.go
@@ -54,10 +54,10 @@ func (suite *StatusFaveTestSuite) SetupTest() {
 	suite.config = testrig.NewTestConfig()
 	suite.db = testrig.NewTestDB()
 	suite.storage = testrig.NewTestStorage()
-	suite.log = testrig.NewTestLog()
+	testrig.InitTestLog()
 	suite.federator = testrig.NewTestFederator(suite.db, testrig.NewTestTransportController(testrig.NewMockHTTPClient(nil), suite.db), suite.storage)
 	suite.processor = testrig.NewTestProcessor(suite.db, suite.storage, suite.federator)
-	suite.statusModule = status.New(suite.config, suite.processor, suite.log).(*status.Module)
+	suite.statusModule = status.New(suite.config, suite.processor).(*status.Module)
 	testrig.StandardDBSetup(suite.db, nil)
 	testrig.StandardStorageSetup(suite.storage, "../../../../testrig/media")
 }
diff --git a/internal/api/client/status/statusfavedby.go b/internal/api/client/status/statusfavedby.go
index 4ed6e74ed..4de66d65d 100644
--- a/internal/api/client/status/statusfavedby.go
+++ b/internal/api/client/status/statusfavedby.go
@@ -63,7 +63,7 @@ import (
 //   '404':
 //      description: not found
 func (m *Module) StatusFavedByGETHandler(c *gin.Context) {
-	l := m.log.WithFields(logrus.Fields{
+	l := logrus.WithFields(logrus.Fields{
 		"func":        "statusGETHandler",
 		"request_uri": c.Request.RequestURI,
 		"user_agent":  c.Request.UserAgent(),
diff --git a/internal/api/client/status/statusfavedby_test.go b/internal/api/client/status/statusfavedby_test.go
index 7475f1e69..2958379fa 100644
--- a/internal/api/client/status/statusfavedby_test.go
+++ b/internal/api/client/status/statusfavedby_test.go
@@ -54,10 +54,10 @@ func (suite *StatusFavedByTestSuite) SetupTest() {
 	suite.config = testrig.NewTestConfig()
 	suite.db = testrig.NewTestDB()
 	suite.storage = testrig.NewTestStorage()
-	suite.log = testrig.NewTestLog()
+	testrig.InitTestLog()
 	suite.federator = testrig.NewTestFederator(suite.db, testrig.NewTestTransportController(testrig.NewMockHTTPClient(nil), suite.db), suite.storage)
 	suite.processor = testrig.NewTestProcessor(suite.db, suite.storage, suite.federator)
-	suite.statusModule = status.New(suite.config, suite.processor, suite.log).(*status.Module)
+	suite.statusModule = status.New(suite.config, suite.processor).(*status.Module)
 	testrig.StandardDBSetup(suite.db, nil)
 	testrig.StandardStorageSetup(suite.storage, "../../../../testrig/media")
 }
diff --git a/internal/api/client/status/statusget.go b/internal/api/client/status/statusget.go
index 3c74b53c8..b246002d8 100644
--- a/internal/api/client/status/statusget.go
+++ b/internal/api/client/status/statusget.go
@@ -62,7 +62,7 @@ import (
 //   '500':
 //      description: internal error
 func (m *Module) StatusGETHandler(c *gin.Context) {
-	l := m.log.WithFields(logrus.Fields{
+	l := logrus.WithFields(logrus.Fields{
 		"func":        "statusGETHandler",
 		"request_uri": c.Request.RequestURI,
 		"user_agent":  c.Request.UserAgent(),
diff --git a/internal/api/client/status/statusget_test.go b/internal/api/client/status/statusget_test.go
index fa5f786cb..17326b466 100644
--- a/internal/api/client/status/statusget_test.go
+++ b/internal/api/client/status/statusget_test.go
@@ -44,10 +44,10 @@ func (suite *StatusGetTestSuite) SetupTest() {
 	suite.config = testrig.NewTestConfig()
 	suite.db = testrig.NewTestDB()
 	suite.storage = testrig.NewTestStorage()
-	suite.log = testrig.NewTestLog()
+	testrig.InitTestLog()
 	suite.federator = testrig.NewTestFederator(suite.db, testrig.NewTestTransportController(testrig.NewMockHTTPClient(nil), suite.db), suite.storage)
 	suite.processor = testrig.NewTestProcessor(suite.db, suite.storage, suite.federator)
-	suite.statusModule = status.New(suite.config, suite.processor, suite.log).(*status.Module)
+	suite.statusModule = status.New(suite.config, suite.processor).(*status.Module)
 	testrig.StandardDBSetup(suite.db, nil)
 	testrig.StandardStorageSetup(suite.storage, "../../../../testrig/media")
 }
diff --git a/internal/api/client/status/statusunboost.go b/internal/api/client/status/statusunboost.go
index f114dbd0c..7ddb274e0 100644
--- a/internal/api/client/status/statusunboost.go
+++ b/internal/api/client/status/statusunboost.go
@@ -63,7 +63,7 @@ import (
 //   '404':
 //      description: not found
 func (m *Module) StatusUnboostPOSTHandler(c *gin.Context) {
-	l := m.log.WithFields(logrus.Fields{
+	l := logrus.WithFields(logrus.Fields{
 		"func":        "StatusUnboostPOSTHandler",
 		"request_uri": c.Request.RequestURI,
 		"user_agent":  c.Request.UserAgent(),
diff --git a/internal/api/client/status/statusunfave.go b/internal/api/client/status/statusunfave.go
index 3689e1899..29d3daa47 100644
--- a/internal/api/client/status/statusunfave.go
+++ b/internal/api/client/status/statusunfave.go
@@ -62,7 +62,7 @@ import (
 //   '404':
 //      description: not found
 func (m *Module) StatusUnfavePOSTHandler(c *gin.Context) {
-	l := m.log.WithFields(logrus.Fields{
+	l := logrus.WithFields(logrus.Fields{
 		"func":        "StatusUnfavePOSTHandler",
 		"request_uri": c.Request.RequestURI,
 		"user_agent":  c.Request.UserAgent(),
diff --git a/internal/api/client/status/statusunfave_test.go b/internal/api/client/status/statusunfave_test.go
index 9e7ea8f82..e99569e0a 100644
--- a/internal/api/client/status/statusunfave_test.go
+++ b/internal/api/client/status/statusunfave_test.go
@@ -54,10 +54,10 @@ func (suite *StatusUnfaveTestSuite) SetupTest() {
 	suite.config = testrig.NewTestConfig()
 	suite.db = testrig.NewTestDB()
 	suite.storage = testrig.NewTestStorage()
-	suite.log = testrig.NewTestLog()
+	testrig.InitTestLog()
 	suite.federator = testrig.NewTestFederator(suite.db, testrig.NewTestTransportController(testrig.NewMockHTTPClient(nil), suite.db), suite.storage)
 	suite.processor = testrig.NewTestProcessor(suite.db, suite.storage, suite.federator)
-	suite.statusModule = status.New(suite.config, suite.processor, suite.log).(*status.Module)
+	suite.statusModule = status.New(suite.config, suite.processor).(*status.Module)
 	testrig.StandardDBSetup(suite.db, nil)
 	testrig.StandardStorageSetup(suite.storage, "../../../../testrig/media")
 }