mirrors/gotosocial
1
0
Fork 0
mirror of https://github.com/superseriousbusiness/gotosocial.git synced 2025-10-29 06:42:25 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

reference global logrus (#274)

Browse source 
* 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
This commit is contained in:
R. Aidan Campbell 2021-10-11 05:37:33 -07:00 • committed by GitHub
commit 083099a957
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
210 changed files with 506 additions and 662 deletions
Download patch file Download diff file Expand all files Collapse all files

7
internal/trans/exporter.go
View file

@ -21,7 +21,6 @@ package trans
import (
"context"
"github.com/sirupsen/logrus"
"github.com/superseriousbusiness/gotosocial/internal/db"
)
@ -32,15 +31,13 @@ type Exporter interface {
type exporter struct {
db db.DB
log *logrus.Logger
writtenIDs map[string]bool
}
// NewExporter returns a new Exporter that will use the given db and logger.
func NewExporter(db db.DB, log *logrus.Logger) Exporter {
// NewExporter returns a new Exporter that will use the given db.
func NewExporter(db db.DB) Exporter {
return &exporter{
db: db,
log: log,
writtenIDs: make(map[string]bool),
}
}

2
internal/trans/exportminimal_test.go
View file

@ -38,7 +38,7 @@ func (suite *ExportMinimalTestSuite) TestExportMinimalOK() {
tempFilePath := fmt.Sprintf("%s/%s", suite.T().TempDir(), uuid.NewString())
// export to the tempFilePath
exporter := trans.NewExporter(suite.db, suite.log)
exporter := trans.NewExporter(suite.db)
err := exporter.ExportMinimal(context.Background(), tempFilePath)
suite.NoError(err)

19
internal/trans/import.go
View file

@ -23,6 +23,7 @@ import (
"encoding/json"
"errors"
"fmt"
"github.com/sirupsen/logrus"
"io"
"os"
@ -47,7 +48,7 @@ func (i *importer) Import(ctx context.Context, path string) error {
err := decoder.Decode(&entry)
if err != nil {
if err == io.EOF {
i.log.Infof("Import: reached end of file")
logrus.Infof("Import: reached end of file")
return neatClose(file)
}
return fmt.Errorf("Import: error decoding in readLoop: %s", err)
@ -73,7 +74,7 @@ func (i *importer) inputEntry(ctx context.Context, entry transmodel.Entry) error
if err := i.putInDB(ctx, account); err != nil {
return fmt.Errorf("inputEntry: error adding account to database: %s", err)
}
i.log.Infof("inputEntry: added account with id %s", account.ID)
logrus.Infof("inputEntry: added account with id %s", account.ID)
return nil
case transmodel.TransBlock:
block, err := i.blockDecode(entry)
@ -83,7 +84,7 @@ func (i *importer) inputEntry(ctx context.Context, entry transmodel.Entry) error
if err := i.putInDB(ctx, block); err != nil {
return fmt.Errorf("inputEntry: error adding block to database: %s", err)
}
i.log.Infof("inputEntry: added block with id %s", block.ID)
logrus.Infof("inputEntry: added block with id %s", block.ID)
return nil
case transmodel.TransDomainBlock:
block, err := i.domainBlockDecode(entry)
@ -93,7 +94,7 @@ func (i *importer) inputEntry(ctx context.Context, entry transmodel.Entry) error
if err := i.putInDB(ctx, block); err != nil {
return fmt.Errorf("inputEntry: error adding domain block to database: %s", err)
}
i.log.Infof("inputEntry: added domain block with id %s", block.ID)
logrus.Infof("inputEntry: added domain block with id %s", block.ID)
return nil
case transmodel.TransFollow:
follow, err := i.followDecode(entry)
@ -103,7 +104,7 @@ func (i *importer) inputEntry(ctx context.Context, entry transmodel.Entry) error
if err := i.putInDB(ctx, follow); err != nil {
return fmt.Errorf("inputEntry: error adding follow to database: %s", err)
}
i.log.Infof("inputEntry: added follow with id %s", follow.ID)
logrus.Infof("inputEntry: added follow with id %s", follow.ID)
return nil
case transmodel.TransFollowRequest:
fr, err := i.followRequestDecode(entry)
@ -113,7 +114,7 @@ func (i *importer) inputEntry(ctx context.Context, entry transmodel.Entry) error
if err := i.putInDB(ctx, fr); err != nil {
return fmt.Errorf("inputEntry: error adding follow request to database: %s", err)
}
i.log.Infof("inputEntry: added follow request with id %s", fr.ID)
logrus.Infof("inputEntry: added follow request with id %s", fr.ID)
return nil
case transmodel.TransInstance:
inst, err := i.instanceDecode(entry)
@ -123,7 +124,7 @@ func (i *importer) inputEntry(ctx context.Context, entry transmodel.Entry) error
if err := i.putInDB(ctx, inst); err != nil {
return fmt.Errorf("inputEntry: error adding instance to database: %s", err)
}
i.log.Infof("inputEntry: added instance with id %s", inst.ID)
logrus.Infof("inputEntry: added instance with id %s", inst.ID)
return nil
case transmodel.TransUser:
user, err := i.userDecode(entry)
@ -133,11 +134,11 @@ func (i *importer) inputEntry(ctx context.Context, entry transmodel.Entry) error
if err := i.putInDB(ctx, user); err != nil {
return fmt.Errorf("inputEntry: error adding user to database: %s", err)
}
i.log.Infof("inputEntry: added user with id %s", user.ID)
logrus.Infof("inputEntry: added user with id %s", user.ID)
return nil
}
i.log.Errorf("inputEntry: didn't recognize transtype '%s', skipping it", t)
logrus.Errorf("inputEntry: didn't recognize transtype '%s', skipping it", t)
return nil
}

4
internal/trans/import_test.go
View file

@ -42,7 +42,7 @@ func (suite *ImportMinimalTestSuite) TestImportMinimalOK() {
tempFilePath := fmt.Sprintf("%s/%s", suite.T().TempDir(), uuid.NewString())
// export to the tempFilePath
exporter := trans.NewExporter(suite.db, suite.log)
exporter := trans.NewExporter(suite.db)
err := exporter.ExportMinimal(ctx, tempFilePath)
suite.NoError(err)
@ -57,7 +57,7 @@ func (suite *ImportMinimalTestSuite) TestImportMinimalOK() {
newDB := testrig.NewTestDB()
testrig.CreateTestTables(newDB)
importer := trans.NewImporter(newDB, suite.log)
importer := trans.NewImporter(newDB)
err = importer.Import(ctx, tempFilePath)
suite.NoError(err)

7
internal/trans/importer.go
View file

@ -21,7 +21,6 @@ package trans
import (
"context"
"github.com/sirupsen/logrus"
"github.com/superseriousbusiness/gotosocial/internal/db"
)
@ -32,13 +31,11 @@ type Importer interface {
type importer struct {
db db.DB
log *logrus.Logger
}
// NewImporter returns a new Importer interface that uses the given db and logger.
func NewImporter(db db.DB, log *logrus.Logger) Importer {
// NewImporter returns a new Importer interface that uses the given db.
func NewImporter(db db.DB) Importer {
return &importer{
db: db,
log: log,
}
}

4
internal/trans/trans_test.go
View file

@ -19,7 +19,6 @@
package trans_test
import (
"github.com/sirupsen/logrus"
"github.com/stretchr/testify/suite"
"github.com/superseriousbusiness/gotosocial/internal/db"
"github.com/superseriousbusiness/gotosocial/testrig"
@ -28,12 +27,11 @@ import (
type TransTestSuite struct {
suite.Suite
db db.DB
log *logrus.Logger
}
func (suite *TransTestSuite) SetupTest() {
suite.db = testrig.NewTestDB()
suite.log = testrig.NewTestLog()
testrig.InitTestLog()
testrig.StandardDBSetup(suite.db, nil)
}