feat: use golangci-lint for code static analysis

.github/workflows/go-check.yml

@@ -16,3 +16,9 @@ concurrency:
 jobs:
   go-check:
     uses: ipdxco/unified-github-workflows/.github/workflows/[email protected]
+
+  golangci-lint:    
+    - name: golangci-lint
+      uses: golangci/golangci-lint-action@v6
+      with:
+        version: latest

.golangci.yaml

@@ -0,0 +1,17 @@
+linters:
+  disable-all: true
+  enable:
+    - gci
+    - gofumpt
+    - gosimple
+    - govet
+    - ineffassign
+    - misspell
+    - staticcheck
+    - unconvert
+    - unused
+    - usestdlibvars
+
+issue:
+  exclude-files:
+    - ".*\\.pb\\.go"

CHANGELOG.md

@@ -24,6 +24,7 @@ The following emojis are used to highlight certain changes:
 - `gateway` The default DNSLink resolver for `.eth` TLD changed to `https://dns.eth.limo/dns-query` [#781](https://github.com/ipfs/boxo/pull/781)
 - `gateway` The default DNSLink resolver for `.crypto` TLD changed to `https://resolver.unstoppable.io/dns-query` [#782](https://github.com/ipfs/boxo/pull/782)
 - upgrade to `go-libp2p-kad-dht` [v0.28.2](https://github.com/libp2p/go-libp2p-kad-dht/releases/tag/v0.28.2)
+- use golangci-lint for linting
 
 ### Removed
 

bitswap/bitswap.go

@@ -9,15 +9,13 @@ import (
 	"github.com/ipfs/boxo/bitswap/network"
 	"github.com/ipfs/boxo/bitswap/server"
 	"github.com/ipfs/boxo/bitswap/tracer"
-	"github.com/ipfs/go-metrics-interface"
-
 	blockstore "github.com/ipfs/boxo/blockstore"
 	exchange "github.com/ipfs/boxo/exchange"
 	blocks "github.com/ipfs/go-block-format"
 	"github.com/ipfs/go-cid"
 	logging "github.com/ipfs/go-log/v2"
+	"github.com/ipfs/go-metrics-interface"
 	"github.com/libp2p/go-libp2p/core/peer"
-
 	"go.uber.org/multierr"
 )
 

bitswap/client/internal/getter/getter.go

@@ -6,11 +6,10 @@ import (
 
 	"github.com/ipfs/boxo/bitswap/client/internal"
 	notifications "github.com/ipfs/boxo/bitswap/client/internal/notifications"
-	logging "github.com/ipfs/go-log/v2"
-
 	blocks "github.com/ipfs/go-block-format"
 	cid "github.com/ipfs/go-cid"
 	ipld "github.com/ipfs/go-ipld-format"
+	logging "github.com/ipfs/go-log/v2"
 )
 
 var log = logging.Logger("bitswap/client/getter")

bitswap/client/internal/peermanager/peermanager.go

@@ -4,10 +4,9 @@ import (
 	"context"
 	"sync"
 
+	cid "github.com/ipfs/go-cid"
 	logging "github.com/ipfs/go-log/v2"
 	"github.com/ipfs/go-metrics-interface"
-
-	cid "github.com/ipfs/go-cid"
 	peer "github.com/libp2p/go-libp2p/core/peer"
 )
 

bitswap/client/internal/peermanager/peerwantmanager.go

@@ -158,7 +158,6 @@ func (pwm *peerWantManager) broadcastWantHaves(wantHaves []cid.Cid) {
 // sendWants only sends the peer the want-blocks and want-haves that have not
 // already been sent to it.
 func (pwm *peerWantManager) sendWants(p peer.ID, wantBlocks []cid.Cid, wantHaves []cid.Cid) {
-
 	// Get the existing want-blocks and want-haves for the peer
 	pws, ok := pwm.peerWants[p]
 	if !ok {

bitswap/client/internal/session/session_test.go

@@ -145,6 +145,7 @@ func (pm *fakePeerManager) UnregisterSession(uint64)              {}
 func (pm *fakePeerManager) SendWants(context.Context, peer.ID, []cid.Cid, []cid.Cid) bool {
 	return true
 }
+
 func (pm *fakePeerManager) BroadcastWantHaves(ctx context.Context, cids []cid.Cid) {
 	select {
 	case pm.wantReqs <- wantReq{cids}:
@@ -287,7 +288,7 @@ func TestSessionFindMorePeers(t *testing.T) {
 		// Make sure the first block is not included because it has already
 		// been received
 		for _, c := range receivedWantReq.cids {
-			require.False(t, c.Equals(cids[0]), "should not braodcast block that was already received")
+			require.False(t, c.Equals(cids[0]), "should not broadcast block that was already received")
 		}
 	case <-ctx.Done():
 		t.Fatal("Never rebroadcast want list")

bitswap/client/internal/session/sessionwantsender.go

@@ -4,7 +4,6 @@ import (
 	"context"
 
 	bsbpm "github.com/ipfs/boxo/bitswap/client/internal/blockpresencemanager"
-
 	cid "github.com/ipfs/go-cid"
 	peer "github.com/libp2p/go-libp2p/core/peer"
 )

bitswap/client/internal/sessioninterestmanager/sessioninterestmanager.go

@@ -4,7 +4,6 @@ import (
 	"sync"
 
 	blocks "github.com/ipfs/go-block-format"
-
 	cid "github.com/ipfs/go-cid"
 )
 

bitswap/client/internal/sessionmanager/sessionmanager.go

@@ -6,18 +6,17 @@ import (
 	"sync"
 	"time"
 
-	cid "github.com/ipfs/go-cid"
-	delay "github.com/ipfs/go-ipfs-delay"
-	"go.opentelemetry.io/otel/attribute"
-	"go.opentelemetry.io/otel/trace"
-
 	"github.com/ipfs/boxo/bitswap/client/internal"
 	bsbpm "github.com/ipfs/boxo/bitswap/client/internal/blockpresencemanager"
 	notifications "github.com/ipfs/boxo/bitswap/client/internal/notifications"
 	bssession "github.com/ipfs/boxo/bitswap/client/internal/session"
 	bssim "github.com/ipfs/boxo/bitswap/client/internal/sessioninterestmanager"
 	exchange "github.com/ipfs/boxo/exchange"
+	cid "github.com/ipfs/go-cid"
+	delay "github.com/ipfs/go-ipfs-delay"
 	peer "github.com/libp2p/go-libp2p/core/peer"
+	"go.opentelemetry.io/otel/attribute"
+	"go.opentelemetry.io/otel/trace"
 )
 
 // Session is a session that is managed by the session manager

bitswap/client/internal/sessionpeermanager/sessionpeermanager.go

@@ -5,7 +5,6 @@ import (
 	"sync"
 
 	logging "github.com/ipfs/go-log/v2"
-
 	peer "github.com/libp2p/go-libp2p/core/peer"
 )
 

bitswap/client/wantlist/wantlist.go

@@ -6,7 +6,6 @@ import (
 	"sort"
 
 	pb "github.com/ipfs/boxo/bitswap/message/pb"
-
 	cid "github.com/ipfs/go-cid"
 )
 

bitswap/message/message.go

@@ -7,14 +7,12 @@ import (
 
 	"github.com/ipfs/boxo/bitswap/client/wantlist"
 	pb "github.com/ipfs/boxo/bitswap/message/pb"
-
+	u "github.com/ipfs/boxo/util"
 	blocks "github.com/ipfs/go-block-format"
 	cid "github.com/ipfs/go-cid"
 	pool "github.com/libp2p/go-buffer-pool"
-	msgio "github.com/libp2p/go-msgio"
-
-	u "github.com/ipfs/boxo/util"
 	"github.com/libp2p/go-libp2p/core/network"
+	msgio "github.com/libp2p/go-msgio"
 )
 
 // BitSwapMessage is the basic interface for interacting building, encoding,
@@ -116,7 +114,7 @@ func (e *Entry) Size() int {
 func (e *Entry) ToPB() pb.Message_Wantlist_Entry {
 	return pb.Message_Wantlist_Entry{
 		Block:        pb.Cid{Cid: e.Cid},
-		Priority:     int32(e.Priority),
+		Priority:     e.Priority,
 		Cancel:       e.Cancel,
 		WantType:     e.WantType,
 		SendDontHave: e.SendDontHave,

bitswap/message/pb/cid_test.go

@@ -4,10 +4,9 @@ import (
 	"bytes"
 	"testing"
 
+	pb "github.com/ipfs/boxo/bitswap/message/pb"
 	u "github.com/ipfs/boxo/util"
 	"github.com/ipfs/go-cid"
-
-	pb "github.com/ipfs/boxo/bitswap/message/pb"
 )
 
 func TestCID(t *testing.T) {

bitswap/network/interface.go

@@ -6,9 +6,7 @@ import (
 
 	bsmsg "github.com/ipfs/boxo/bitswap/message"
 	"github.com/ipfs/boxo/bitswap/network/internal"
-
 	cid "github.com/ipfs/go-cid"
-
 	"github.com/libp2p/go-libp2p/core/connmgr"
 	"github.com/libp2p/go-libp2p/core/peer"
 	"github.com/libp2p/go-libp2p/p2p/protocol/ping"

bitswap/network/ipfs_impl.go

@@ -10,7 +10,6 @@ import (
 
 	bsmsg "github.com/ipfs/boxo/bitswap/message"
 	"github.com/ipfs/boxo/bitswap/network/internal"
-
 	logging "github.com/ipfs/go-log/v2"
 	"github.com/libp2p/go-libp2p/core/connmgr"
 	"github.com/libp2p/go-libp2p/core/host"

bitswap/server/internal/decision/engine.go

@@ -248,7 +248,7 @@ type TaskInfo struct {
 type TaskComparator func(ta, tb *TaskInfo) bool
 
 // PeerBlockRequestFilter is used to accept / deny requests for a CID coming from a PeerID
-// It should return true if the request should be fullfilled.
+// It should return true if the request should be fulfilled.
 type PeerBlockRequestFilter func(p peer.ID, c cid.Cid) bool
 
 type Option func(*Engine)
@@ -683,7 +683,7 @@ func (e *Engine) MessageReceived(ctx context.Context, p peer.ID, m bsmsg.BitSwap
 
 	wants, cancels, denials, err := e.splitWantsCancelsDenials(p, m)
 	if err != nil {
-		// This is a truely broken client, let's kill the connection.
+		// This is a truly broken client, let's kill the connection.
 		log.Warnw(err.Error(), "local", e.self, "remote", p)
 		return true
 	}

bitswap/server/internal/decision/engine_test.go

@@ -912,8 +912,7 @@ func TestSendReceivedBlocksToPeersThatWantThem(t *testing.T) {
 	_, env = getNextEnvelope(e, next, 5*time.Millisecond)
 	if env == nil {
 		t.Fatal("expected envelope")
-	}
-	if env.Peer != partner {
+	} else if env.Peer != partner {
 		t.Fatal("expected message to peer")
 	}
 	sentBlk := env.Message.Blocks()
@@ -947,8 +946,7 @@ func TestSendDontHave(t *testing.T) {
 	next, env := getNextEnvelope(e, next, 10*time.Millisecond)
 	if env == nil {
 		t.Fatal("expected envelope")
-	}
-	if env.Peer != partner {
+	} else if env.Peer != partner {
 		t.Fatal("expected message to peer")
 	}
 	if len(env.Message.Blocks()) > 0 {
@@ -978,8 +976,7 @@ func TestSendDontHave(t *testing.T) {
 	_, env = getNextEnvelope(e, next, 10*time.Millisecond)
 	if env == nil {
 		t.Fatal("expected envelope")
-	}
-	if env.Peer != partner {
+	} else if env.Peer != partner {
 		t.Fatal("expected message to peer")
 	}
 	if len(env.Message.Blocks()) != 2 {

bitswap/server/internal/decision/peer_ledger.go

@@ -3,7 +3,6 @@ package decision
 import (
 	wl "github.com/ipfs/boxo/bitswap/client/wantlist"
 	pb "github.com/ipfs/boxo/bitswap/message/pb"
-
 	"github.com/ipfs/go-cid"
 	"github.com/libp2p/go-libp2p/core/peer"
 )

bitswap/server/server.go

@@ -408,7 +408,7 @@ func (bs *Server) NotifyNewBlocks(ctx context.Context, blks ...blocks.Block) err
 
 func (bs *Server) ReceiveMessage(ctx context.Context, p peer.ID, incoming message.BitSwapMessage) {
 	// This call records changes to wantlists, blocks received,
-	// and number of bytes transfered.
+	// and number of bytes transferred.
 	mustKillConnection := bs.engine.MessageReceived(ctx, p, incoming)
 	if mustKillConnection {
 		bs.network.DisconnectFrom(ctx, p)
@@ -422,7 +422,7 @@ func (bs *Server) ReceiveMessage(ctx context.Context, p peer.ID, incoming messag
 }
 
 // ReceivedBlocks notify the decision engine that a peer is well behaving
-// and gave us usefull data, potentially increasing it's score and making us
+// and gave us useful data, potentially increasing it's score and making us
 // send them more data in exchange.
 func (bs *Server) ReceivedBlocks(from peer.ID, blks []blocks.Block) {
 	bs.engine.ReceivedBlocks(from, blks)

bitswap/testnet/interface.go

@@ -2,7 +2,6 @@ package bitswap
 
 import (
 	bsnet "github.com/ipfs/boxo/bitswap/network"
-
 	tnet "github.com/libp2p/go-libp2p-testing/net"
 	"github.com/libp2p/go-libp2p/core/peer"
 )

bitswap/testnet/network_test.go

@@ -7,10 +7,8 @@ import (
 
 	bsmsg "github.com/ipfs/boxo/bitswap/message"
 	bsnet "github.com/ipfs/boxo/bitswap/network"
-
 	blocks "github.com/ipfs/go-block-format"
 	delay "github.com/ipfs/go-ipfs-delay"
-
 	tnet "github.com/libp2p/go-libp2p-testing/net"
 	"github.com/libp2p/go-libp2p/core/peer"
 )

bitswap/testnet/peernet.go

@@ -4,7 +4,6 @@ import (
 	"context"
 
 	bsnet "github.com/ipfs/boxo/bitswap/network"
-
 	tnet "github.com/libp2p/go-libp2p-testing/net"
 	"github.com/libp2p/go-libp2p/core/peer"
 	mockpeernet "github.com/libp2p/go-libp2p/p2p/net/mock"

blockservice/blockservice.go

@@ -8,18 +8,16 @@ import (
 	"io"
 	"sync"
 
-	"go.opentelemetry.io/otel/attribute"
-	"go.opentelemetry.io/otel/trace"
-
+	"github.com/ipfs/boxo/blockservice/internal"
 	"github.com/ipfs/boxo/blockstore"
 	"github.com/ipfs/boxo/exchange"
 	"github.com/ipfs/boxo/verifcid"
 	blocks "github.com/ipfs/go-block-format"
 	"github.com/ipfs/go-cid"
 	ipld "github.com/ipfs/go-ipld-format"
 	logging "github.com/ipfs/go-log/v2"
-
-	"github.com/ipfs/boxo/blockservice/internal"
+	"go.opentelemetry.io/otel/attribute"
+	"go.opentelemetry.io/otel/trace"
 )
 
 var logger = logging.Logger("blockservice")
@@ -488,7 +486,7 @@ func ContextWithSession(ctx context.Context, bs BlockService) context.Context {
 
 // EmbedSessionInContext is like [ContextWithSession] but it allows to embed an existing session.
 func EmbedSessionInContext(ctx context.Context, ses *Session) context.Context {
-	// use ses.bs as a key, so if multiple blockservices use embeded sessions it gets dispatched to the matching blockservice.
+	// use ses.bs as a key, so if multiple blockservices use embedded sessions it gets dispatched to the matching blockservice.
 	return context.WithValue(ctx, ses.bs, ses)
 }
 

blockservice/test/blocks_test.go

@@ -8,7 +8,6 @@ import (
 	"time"
 
 	. "github.com/ipfs/boxo/blockservice"
-
 	blockstore "github.com/ipfs/boxo/blockstore"
 	offline "github.com/ipfs/boxo/exchange/offline"
 	u "github.com/ipfs/boxo/util"

blockstore/blockstore.go

@@ -83,13 +83,13 @@ type Viewer interface {
 // garbage-collection operations.
 type GCLocker interface {
 	// GCLock locks the blockstore for garbage collection. No operations
-	// that expect to finish with a pin should ocurr simultaneously.
+	// that expect to finish with a pin should occur simultaneously.
 	// Reading during GC is safe, and requires no lock.
 	GCLock(context.Context) Unlocker
 
 	// PinLock locks the blockstore for sequences of puts expected to finish
 	// with a pin (before GC). Multiple put->pin sequences can write through
-	// at the same time, but no GC should happen simulatenously.
+	// at the same time, but no GC should happen simultaneously.
 	// Reading during Pinning is safe, and requires no lock.
 	PinLock(context.Context) Unlocker
 

blockstore/caching.go

@@ -8,7 +8,7 @@ import (
 )
 
 // CacheOpts wraps options for CachedBlockStore().
-// Next to each option is it aproximate memory usage per unit
+// Next to each option is it approximate memory usage per unit
 type CacheOpts struct {
 	HasBloomFilterSize   int // 1 byte
 	HasBloomFilterHashes int // No size, 7 is usually best, consult bloom papers

bootstrap/bootstrap_test.go

@@ -125,7 +125,6 @@ func TestNoTempPeersLoadAndSave(t *testing.T) {
 
 	time.Sleep(4 * period)
 	bootstrapper.Close()
-
 }
 
 func assertPanics(t *testing.T, name string, f func()) {