feat: standardize logging

.github/golangci.yml

@@ -37,6 +37,7 @@ linters:
     - errorlint # errorlint is a linter for that can be used to find code that will cause problems with the error wrapping scheme introduced in Go 1.13
     - gofumpt # Stricter gofmt
     - unused # Checks Go code for unused constants, variables, functions and types
+    - gomodguard # Enforces an allow and block list for direct Go module dependencies
 
 linters-settings:
   gofmt:
@@ -59,6 +60,17 @@ linters-settings:
       - opinionated
       - performance
       - style
+  gomodguard:
+    blocked:
+      modules:
+        - log/slog:
+            recommendations:
+              - golang.org/x/exp
+            reason: "the minimum go version for the monorepo is 1.20"
+      versions:
+        - go.uber.org/zap/exp:
+            version: "> 0.1.0"
+            reason: "this version of zap/exp is a requirement until we upgrade to go 1.21 (https://github.com/uber-go/zap/blob/master/exp/CHANGELOG.md)"
 
 issues:
   whole-files: true

.github/workflows/lint.yml

@@ -58,6 +58,34 @@ jobs:
           else
             echo 'Succeeded.'
           fi
+  imports:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: 1.21.x
+
+      - name: Install make
+        run: sudo apt-get install -y make
+
+      # prefill dependencies so that mod messages don't show up in make output
+      - name: Fetch dependencies
+        run: go mod download -modfile ./misc/devdeps/go.mod -x
+
+      - name: Check goimports
+        run: |
+          output="$(GOIMPORTS_FLAGS=-l make -s imports)"
+          if [ ! -z "$output" ]; then
+            echo "The following files are not properly formatted; run 'make imports' to format them."
+            echo "$output"
+            exit 1
+          else
+            echo 'Succeeded.'
+          fi
   mod_tidy_check:
     runs-on: ubuntu-latest
     if: ${{ github.actor != 'dependabot[bot]' }}

Makefile

@@ -45,3 +45,13 @@ fmt:
 .PHONY: lint
 lint:
 	$(rundep) github.com/golangci/golangci-lint/cmd/golangci-lint run --config .github/golangci.yml
+
+.PHONY: imports
+imports:
+	$(MAKE) --no-print-directory -C tm2      imports
+	$(MAKE) --no-print-directory -C gnovm    imports
+	$(MAKE) --no-print-directory -C gno.land imports
+
+.PHONY: tidy
+tidy:
+	$(MAKE) --no-print-directory -C misc     tidy

contribs/gnodev/go.mod

@@ -7,6 +7,8 @@ replace github.com/gnolang/gno => ../..
 require (
 	github.com/fsnotify/fsnotify v1.7.0
 	github.com/gnolang/gno v0.0.0-00010101000000-000000000000
+	go.uber.org/zap v1.24.0
+	golang.org/x/exp v0.0.0-20240112132812-db7319d0e0e3
 	golang.org/x/term v0.16.0
 )
 
@@ -37,6 +39,7 @@ require (
 	github.com/jaekwon/testify v1.6.1 // indirect
 	github.com/jmhodges/levigo v1.0.0 // indirect
 	github.com/klauspost/compress v1.12.3 // indirect
+	github.com/kr/pretty v0.2.1 // indirect
 	github.com/libp2p/go-buffer-pool v0.1.0 // indirect
 	github.com/linxGnu/grocksdb v1.8.11 // indirect
 	github.com/pelletier/go-toml v1.9.5 // indirect
@@ -49,7 +52,9 @@ require (
 	github.com/tecbot/gorocksdb v0.0.0-20191217155057-f0fad39f321c // indirect
 	go.etcd.io/bbolt v1.3.8 // indirect
 	go.opencensus.io v0.22.5 // indirect
+	go.uber.org/atomic v1.10.0 // indirect
 	go.uber.org/multierr v1.10.0 // indirect
+	go.uber.org/zap/exp v0.1.0 // indirect
 	golang.org/x/crypto v0.18.0 // indirect
 	golang.org/x/mod v0.14.0 // indirect
 	golang.org/x/net v0.20.0 // indirect

contribs/gnodev/main.go

@@ -16,11 +16,12 @@ import (
 	gnodev "github.com/gnolang/gno/contribs/gnodev/pkg/dev"
 	"github.com/gnolang/gno/contribs/gnodev/pkg/rawterm"
 	"github.com/gnolang/gno/gno.land/pkg/gnoweb"
+	"github.com/gnolang/gno/gno.land/pkg/log"
 	"github.com/gnolang/gno/gnovm/pkg/gnoenv"
 	"github.com/gnolang/gno/gnovm/pkg/gnomod"
 	"github.com/gnolang/gno/tm2/pkg/commands"
-	tmlog "github.com/gnolang/gno/tm2/pkg/log"
 	osm "github.com/gnolang/gno/tm2/pkg/os"
+	"go.uber.org/zap/zapcore"
 )
 
 const (
@@ -61,6 +62,7 @@ additional specified paths.`,
 
 	cmd.Execute(context.Background(), os.Args[1:])
 }
+
 func (c *devCfg) RegisterFlags(fs *flag.FlagSet) {
 	fs.StringVar(
 		&c.webListenerAddr,
@@ -89,7 +91,6 @@ func (c *devCfg) RegisterFlags(fs *flag.FlagSet) {
 		defaultDevOptions.noWatch,
 		"do not watch for files change",
 	)
-
 }
 
 func execDev(cfg *devCfg, args []string, io commands.IO) error {
@@ -303,9 +304,9 @@ func setupRawTerm(io commands.IO) (rt *rawterm.RawTerm, restore func() error, er
 func setupDevNode(ctx context.Context, rt *rawterm.RawTerm, pkgspath []string) (*gnodev.Node, error) {
 	nodeOut := rt.NamespacedWriter("Node")
 
-	logger := tmlog.NewTMLogger(nodeOut)
-	logger.SetLevel(tmlog.LevelError)
-	return gnodev.NewDevNode(ctx, logger, pkgspath)
+	zapLogger := log.NewZapConsoleLogger(nodeOut, zapcore.ErrorLevel)
+
+	return gnodev.NewDevNode(ctx, log.ZapLoggerToSlog(zapLogger), pkgspath)
 }
 
 // setupGnowebServer initializes and starts the Gnoweb server.
@@ -317,10 +318,9 @@ func serveGnoWebServer(l net.Listener, dnode *gnodev.Node, rt *rawterm.RawTerm)
 	webConfig.HelpChainID = dnode.Config().ChainID()
 	webConfig.HelpRemote = dnode.GetRemoteAddress()
 
-	loggerweb := tmlog.NewTMLogger(rt.NamespacedWriter("GnoWeb"))
-	loggerweb.SetLevel(tmlog.LevelDebug)
+	zapLogger := log.NewZapConsoleLogger(rt.NamespacedWriter("GnoWeb"), zapcore.DebugLevel)
 
-	app := gnoweb.MakeApp(loggerweb, webConfig)
+	app := gnoweb.MakeApp(log.ZapLoggerToSlog(zapLogger), webConfig)
 
 	server.ReadHeaderTimeout = 60 * time.Second
 	server.Handler = app.Router

contribs/gnodev/pkg/dev/node.go

@@ -15,10 +15,10 @@ import (
 	"github.com/gnolang/gno/tm2/pkg/bft/node"
 	bft "github.com/gnolang/gno/tm2/pkg/bft/types"
 	"github.com/gnolang/gno/tm2/pkg/crypto"
-	"github.com/gnolang/gno/tm2/pkg/log"
 	"github.com/gnolang/gno/tm2/pkg/std"
-	//backup "github.com/gnolang/tx-archive/backup/client"
-	//restore "github.com/gnolang/tx-archive/restore/client"
+	"golang.org/x/exp/slog"
+	// backup "github.com/gnolang/tx-archive/backup/client"
+	// restore "github.com/gnolang/tx-archive/restore/client"
 )
 
 const gnoDevChainID = "tendermint_test" // XXX: this is hardcoded and cannot be change bellow
@@ -27,7 +27,7 @@ const gnoDevChainID = "tendermint_test" // XXX: this is hardcoded and cannot be
 type Node struct {
 	*node.Node
 
-	logger log.Logger
+	logger *slog.Logger
 	pkgs   PkgsMap // path -> pkg
 }
 
@@ -42,7 +42,7 @@ var (
 	}
 )
 
-func NewDevNode(ctx context.Context, logger log.Logger, pkgslist []string) (*Node, error) {
+func NewDevNode(ctx context.Context, logger *slog.Logger, pkgslist []string) (*Node, error) {
 	mpkgs, err := newPkgsMap(pkgslist)
 	if err != nil {
 		return nil, fmt.Errorf("unable map pkgs list: %w", err)
@@ -102,7 +102,7 @@ func (d *Node) GetRemoteAddress() string {
 	return d.Node.Config().RPC.ListenAddress
 }
 
-// UpdatePackages updates the currently known packages. It will be taken into 
+// UpdatePackages updates the currently known packages. It will be taken into
 // consideration in the next reload of the node.
 func (d *Node) UpdatePackages(paths ...string) error {
 	for _, path := range paths {
@@ -403,7 +403,7 @@ func (pm PkgsMap) Load(creator bft.Address, fee std.Fee, deposit std.Coins) ([]s
 	return txs, nil
 }
 
-func newNode(logger log.Logger, genesis gnoland.GnoGenesisState) (*node.Node, error) {
+func newNode(logger *slog.Logger, genesis gnoland.GnoGenesisState) (*node.Node, error) {
 	rootdir := gnoenv.RootDir()
 
 	nodeConfig := gnoland.NewDefaultInMemoryNodeConfig(rootdir)

contribs/gnodev/pkg/rawterm/rawterm.go

@@ -11,9 +11,7 @@ import (
 	"golang.org/x/term"
 )
 
-var (
-	CRLF = []byte{'\r', '\n'}
-)
+var CRLF = []byte{'\r', '\n'}
 
 // rawTerminal wraps an io.Writer, converting \n to \r\n
 type RawTerm struct {

contribs/gnokeykc/go.mod

@@ -16,6 +16,7 @@ require (
 	github.com/cespare/xxhash v1.1.0 // indirect
 	github.com/cespare/xxhash/v2 v2.1.1 // indirect
 	github.com/danieljoos/wincred v1.2.0 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/decred/dcrd/dcrec/secp256k1/v4 v4.2.0 // indirect
 	github.com/dgraph-io/badger/v3 v3.2103.5 // indirect
 	github.com/dgraph-io/ristretto v0.1.1 // indirect
@@ -30,21 +31,26 @@ require (
 	github.com/golang/snappy v0.0.4 // indirect
 	github.com/google/flatbuffers v1.12.1 // indirect
 	github.com/gorilla/websocket v1.5.1 // indirect
+	github.com/jaekwon/testify v1.6.1 // indirect
 	github.com/jmhodges/levigo v1.0.0 // indirect
 	github.com/klauspost/compress v1.12.3 // indirect
 	github.com/libp2p/go-buffer-pool v0.1.0 // indirect
 	github.com/linxGnu/grocksdb v1.8.11 // indirect
 	github.com/pelletier/go-toml v1.9.5 // indirect
 	github.com/peterbourgon/ff/v3 v3.4.0 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/rs/cors v1.10.1 // indirect
+	github.com/stretchr/testify v1.8.4 // indirect
 	github.com/tecbot/gorocksdb v0.0.0-20191217155057-f0fad39f321c // indirect
 	go.etcd.io/bbolt v1.3.8 // indirect
 	go.opencensus.io v0.22.5 // indirect
 	golang.org/x/crypto v0.18.0 // indirect
+	golang.org/x/exp v0.0.0-20240112132812-db7319d0e0e3 // indirect
 	golang.org/x/mod v0.14.0 // indirect
 	golang.org/x/net v0.20.0 // indirect
 	golang.org/x/sys v0.16.0 // indirect
 	golang.org/x/term v0.16.0 // indirect
 	google.golang.org/protobuf v1.31.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 )