Logging with logrus (#232)

* Use logrus

* Configure logger

* Lint

.golangci.yaml

@@ -1,12 +1,4 @@
 linters-settings:
-  depguard:
-    list-type: blacklist
-    packages:
-      # logging is allowed only by logutils.Log, logrus
-      # is allowed to use only in logutils package
-      - github.com/sirupsen/logrus
-    packages-with-error-message:
-      - github.com/sirupsen/logrus: "logging is allowed only by logutils.Log"
   funlen:
     lines: 100
     statements: 50

api/middleware/logger.go

@@ -4,9 +4,10 @@ import (
 	"bytes"
 	"encoding/json"
 	"io/ioutil"
-	"log"
 	"net/http"
 	"time"
+
+	log "github.com/sirupsen/logrus"
 )
 
 type payload struct {

bls/public_key.go

@@ -1,10 +1,9 @@
 package bls
 
 import (
-	"log"
-
 	"github.com/Worldcoin/hubble-commander/models"
 	"github.com/kilic/bn254/bls"
+	log "github.com/sirupsen/logrus"
 )
 
 func fromBLSPublicKey(blsPK *bls.PublicKey) *models.PublicKey {

commander/batches.go

@@ -1,13 +1,12 @@
 package commander
 
 import (
-	"log"
-
 	"github.com/Worldcoin/hubble-commander/commander/executor"
 	"github.com/Worldcoin/hubble-commander/eth"
 	"github.com/Worldcoin/hubble-commander/models"
 	st "github.com/Worldcoin/hubble-commander/storage"
 	"github.com/ethereum/go-ethereum/accounts/abi/bind"
+	log "github.com/sirupsen/logrus"
 )
 
 func (c *Commander) syncBatches(startBlock, endBlock uint64) error {

commander/commander.go

@@ -1,7 +1,6 @@
 package commander
 
 import (
-	"log"
 	"net/http"
 	"sync"
 
@@ -17,6 +16,7 @@ import (
 	"github.com/Worldcoin/hubble-commander/models/dto"
 	st "github.com/Worldcoin/hubble-commander/storage"
 	"github.com/Worldcoin/hubble-commander/testutils/simulator"
+	log "github.com/sirupsen/logrus"
 	"github.com/ybbus/jsonrpc/v2"
 )
 

commander/executor/create_batch.go

@@ -1,13 +1,13 @@
 package executor
 
 import (
-	"log"
 	"time"
 
 	"github.com/Worldcoin/hubble-commander/bls"
 	"github.com/Worldcoin/hubble-commander/models"
 	"github.com/Worldcoin/hubble-commander/models/enums/txtype"
 	st "github.com/Worldcoin/hubble-commander/storage"
+	log "github.com/sirupsen/logrus"
 )
 
 func (t *TransactionExecutor) CreateAndSubmitBatch(batchType txtype.TransactionType, domain *bls.Domain) (err error) {

commander/executor/create_create2transfer_commitments.go

@@ -1,12 +1,12 @@
 package executor
 
 import (
-	"log"
 	"time"
 
 	"github.com/Worldcoin/hubble-commander/bls"
 	"github.com/Worldcoin/hubble-commander/models"
 	"github.com/Worldcoin/hubble-commander/models/enums/txtype"
+	log "github.com/sirupsen/logrus"
 )
 
 var (

commander/executor/create_transfer_commitments.go

@@ -1,12 +1,12 @@
 package executor
 
 import (
-	"log"
 	"time"
 
 	"github.com/Worldcoin/hubble-commander/bls"
 	"github.com/Worldcoin/hubble-commander/models"
 	"github.com/Worldcoin/hubble-commander/models/enums/txtype"
+	log "github.com/sirupsen/logrus"
 )
 
 var (

commander/executor/sync.go

@@ -1,8 +1,6 @@
 package executor
 
 import (
-	"log"
-
 	"github.com/Worldcoin/hubble-commander/encoder"
 	"github.com/Worldcoin/hubble-commander/eth"
 	"github.com/Worldcoin/hubble-commander/models"
@@ -11,6 +9,7 @@ import (
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/pkg/errors"
+	log "github.com/sirupsen/logrus"
 )
 
 var (

commander/executor/utils.go

@@ -1,10 +1,9 @@
 package executor
 
 import (
-	"log"
-
 	"github.com/Worldcoin/hubble-commander/models"
 	st "github.com/Worldcoin/hubble-commander/storage"
+	log "github.com/sirupsen/logrus"
 )
 
 func logAndSaveTransactionError(storage *st.Storage, transaction *models.TransactionBase, transactionError error) {

commander/new_block.go

@@ -3,12 +3,12 @@ package commander
 import (
 	"context"
 	stdErrors "errors"
-	"log"
 	"math/big"
 
 	"github.com/Worldcoin/hubble-commander/utils/ref"
 	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/pkg/errors"
+	log "github.com/sirupsen/logrus"
 )
 
 var (

config/config.go

@@ -8,6 +8,7 @@ import (
 
 	"github.com/Worldcoin/hubble-commander/models"
 	"github.com/Worldcoin/hubble-commander/utils"
+	"github.com/sirupsen/logrus"
 	"github.com/spf13/viper"
 )
 
@@ -30,6 +31,7 @@ func GetConfig() *Config {
 	setupViper()
 
 	return &Config{
+		Log: getLogConfig(),
 		Bootstrap: &BootstrapConfig{
 			Prune:            false, // overridden in main
 			GenesisAccounts:  getGenesisAccounts(),
@@ -68,6 +70,7 @@ func GetTestConfig() *Config {
 	setupViper()
 
 	return &Config{
+		Log: getLogConfig(),
 		Bootstrap: &BootstrapConfig{
 			Prune:            false, // overridden in main
 			GenesisAccounts:  getGenesisAccounts(),
@@ -127,6 +130,24 @@ func getBadgerPath() string {
 	return path.Join(utils.GetProjectRoot(), "db", "badger", "data")
 }
 
+func getLogConfig() *LogConfig {
+	level, err := logrus.ParseLevel(getString("log.level", "info"))
+	if err != nil {
+		log.Fatalf("invalid log level: %e", err)
+	}
+
+	format := getString("log.level", "text")
+
+	if format != "text" && format != "json" {
+		log.Fatalf("invalid log format: %s", format)
+	}
+
+	return &LogConfig{
+		Level:  level,
+		Format: format,
+	}
+}
+
 func getEthereumConfig() *EthereumConfig {
 	rpcURL := getStringOrNil("ethereum.rpc_url")
 	if rpcURL == nil {

config/get_viper.go

@@ -1,9 +1,9 @@
 package config
 
 import (
-	"log"
 	"time"
 
+	log "github.com/sirupsen/logrus"
 	"github.com/spf13/viper"
 )
 

config/model.go

@@ -4,9 +4,11 @@ import (
 	"time"
 
 	"github.com/Worldcoin/hubble-commander/models"
+	"github.com/sirupsen/logrus"
 )
 
 type Config struct {
+	Log       *LogConfig
 	Bootstrap *BootstrapConfig
 	Rollup    *RollupConfig
 	API       *APIConfig
@@ -15,6 +17,12 @@ type Config struct {
 	Ethereum  *EthereumConfig
 }
 
+type LogConfig struct {
+	Level logrus.Level
+	// "json" or "text" (default)
+	Format string
+}
+
 type BootstrapConfig struct {
 	Prune            bool
 	GenesisAccounts  []models.GenesisAccount

db/postgres/create_database.go

@@ -2,13 +2,13 @@ package postgres
 
 import (
 	"fmt"
-	"log"
 	"strings"
 
 	"github.com/Worldcoin/hubble-commander/config"
 	"github.com/Worldcoin/hubble-commander/utils/ref"
 	"github.com/jmoiron/sqlx"
 	"github.com/pkg/errors"
+	log "github.com/sirupsen/logrus"
 )
 
 func CreateDatabaseIfNotExist(cfg *config.PostgresConfig) (err error) {

e2e/setup/docker_commander.go

@@ -3,7 +3,6 @@ package setup
 import (
 	"context"
 	"fmt"
-	"log"
 	"os"
 	"time"
 
@@ -15,6 +14,7 @@ import (
 	docker "github.com/docker/docker/client"
 	"github.com/docker/docker/pkg/stdcopy"
 	"github.com/docker/go-connections/nat"
+	log "github.com/sirupsen/logrus"
 	"github.com/ybbus/jsonrpc/v2"
 )
 

e2e/sync_test.go

@@ -3,7 +3,7 @@
 package e2e
 
 import (
-	"log"
+	log "github.com/sirupsen/logrus"
 	"testing"
 	"time"
 

encoder/generic_transaction.go

@@ -1,12 +1,11 @@
 package encoder
 
 import (
-	"log"
-
 	"github.com/Worldcoin/hubble-commander/models"
 	"github.com/Worldcoin/hubble-commander/models/enums/txtype"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/pkg/errors"
+	log "github.com/sirupsen/logrus"
 )
 
 func HashGenericTransaction(tx models.GenericTransaction) (*common.Hash, error) {

eth/deployer/account_registry.go

@@ -1,11 +1,10 @@
 package deployer
 
 import (
-	"log"
-
 	"github.com/Worldcoin/hubble-commander/contracts/accountregistry"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/pkg/errors"
+	log "github.com/sirupsen/logrus"
 )
 
 func DeployAccountRegistry(c ChainConnection) (*common.Address, *uint64, *accountregistry.AccountRegistry, error) {

eth/rollup/rollup.go

@@ -1,8 +1,6 @@
 package rollup
 
 import (
-	"log"
-
 	"github.com/Worldcoin/hubble-commander/contracts/accountregistry"
 	"github.com/Worldcoin/hubble-commander/contracts/create2transfer"
 	"github.com/Worldcoin/hubble-commander/contracts/depositmanager"
@@ -17,6 +15,7 @@ import (
 	"github.com/Worldcoin/hubble-commander/models"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/pkg/errors"
+	log "github.com/sirupsen/logrus"
 )
 
 const (

go.mod

@@ -15,6 +15,7 @@ require (
 	github.com/kr/pretty v0.2.0 // indirect
 	github.com/lib/pq v1.9.0 // indirect
 	github.com/pkg/errors v0.9.1
+	github.com/sirupsen/logrus v1.7.0
 	github.com/spf13/viper v1.7.1
 	github.com/stretchr/testify v1.7.0
 	github.com/timshannon/badgerhold/v3 v3.0.0-20210415132401-e7c90fb5919f

main/main.go

@@ -3,17 +3,20 @@ package main
 import (
 	"flag"
 	"fmt"
-	"log"
 	"os"
 	"os/signal"
 	"syscall"
 
 	"github.com/Worldcoin/hubble-commander/commander"
 	"github.com/Worldcoin/hubble-commander/config"
+	log "github.com/sirupsen/logrus"
 )
 
 func main() {
-	cmd := commander.NewCommander(getConfig())
+	cfg := getConfig()
+
+	configureLogger(cfg)
+	cmd := commander.NewCommander(cfg)
 
 	setupCloseHandler(cmd)
 
@@ -23,6 +26,20 @@ func main() {
 	}
 }
 
+func configureLogger(cfg *config.Config) {
+	if cfg.Log.Format == "json" {
+		// Log as JSON instead of the default ASCII formatter.
+		log.SetFormatter(&log.JSONFormatter{})
+	}
+
+	// Output to stdout instead of the default stderr
+	// Can be any io.Writer, see below for File example
+	log.SetOutput(os.Stdout)
+
+	// Only log the warning severity or above.
+	log.SetLevel(cfg.Log.Level)
+}
+
 func getConfig() *config.Config {
 	prune := flag.Bool("prune", false, "drop database before running app")
 	devMode := flag.Bool("dev", false, "disable signature verification")

utils/merkletree/merkle_tree.go

@@ -2,13 +2,13 @@ package merkletree
 
 import (
 	"fmt"
-	"log"
 	"math"
 
 	"github.com/Worldcoin/hubble-commander/models"
 	"github.com/Worldcoin/hubble-commander/utils"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/pkg/errors"
+	log "github.com/sirupsen/logrus"
 )
 
 const MaxDepth = 32