feat(ci): golangci-lint update

ptrus · ptrus · commit 3be638864ca5 · 2025-07-24T09:07:06.000+02:00
diff --git a/.github/workflows/ci-lint.yml b/.github/workflows/ci-lint.yml
@@ -48,8 +48,8 @@ jobs:
         # Skip this step for dependabot pull requests.
         if: always() && github.actor != 'dependabot[bot]'
       - name: Lint Go
-        uses: golangci/golangci-lint-action@v6
+        uses: golangci/golangci-lint-action@v8
         with:
-          version: v1.64.5
+          version: v2.3.0
         # Always run this step so that all linting errors can be seen at once.
         if: always()
diff --git a/.golangci.yml b/.golangci.yml
@@ -1,79 +1,105 @@
-# golangci-lint configuration.
-
-# For more information, see:
-# https://golangci-lint.run/usage/configuration/.
-
-run:
-  timeout: 5m
-
+version: "2"
 linters:
-  # Disable all linters except the ones explicitly listed below.
-  disable-all: true
+  default: none
   enable:
-    - asciicheck
     - bodyclose
+    - copyloopvar
     - depguard
-    - dogsled
-    - dupl
     - errcheck
-    - exhaustive
     - goconst
-    - gocritic
     - gocyclo
-    - godot
-    - gofumpt
-    - goheader
-    - goimports
-    - revive
-    - gomodguard
     - goprintffuncname
     - gosec
-    - gosimple
     - govet
     - ineffassign
     - misspell
-    - nakedret
-    - nestif
-    - noctx
-    - prealloc
+    - revive
     - rowserrcheck
     - staticcheck
-    - stylecheck
-    - sqlclosecheck
-    - typecheck
     - unconvert
-    - unparam
     - unused
-    - whitespace
 
-linters-settings:
-  exhaustive:
-    # Switch statements are to be considered exhaustive if a 'default' case is
-    # present, even if all enum members aren't listed in the switch.
-    default-signifies-exhaustive: true
-  goimports:
-    # Put local imports after 3rd-party packages.
-    local-prefixes: github.com/oasisprotocol/
-  gosec:
-    excludes:
-      # https://github.com/securego/gosec#available-rules
-      - G402
-      - G404
-      - G115
-  depguard:
+  settings:
+    depguard:
+      rules:
+        main:
+          files:
+            - $all
+          allow:
+            - $gostd
+            - github.com/oasisprotocol/oasis-web3-gateway
+            - github.com/oasisprotocol/oasis-core
+            - github.com/oasisprotocol/oasis-sdk
+            - github.com/ethereum/go-ethereum
+            - github.com/gorilla/mux
+            - github.com/gorilla/websocket
+            - github.com/knadh/koanf
+            - github.com/prometheus/client_golang/prometheus
+            - github.com/rs/cors
+            - github.com/spf13/cobra
+            - github.com/stretchr/testify
+            - github.com/uptrace/bun
+            - golang.org/x/crypto
+            - google.golang.org/grpc
+          deny:
+            - pkg: "github.com/pkg/errors"
+              desc: Should be replaced by standard lib errors package
+            - pkg: github.com/fxamacker/cbor/v2
+              desc: Use oasis-core/go/common/cbor instead
+
+  exclusions:
+    generated: lax
     rules:
-      main:
-        files:
-          - $all
-        allow:
-          - $gostd
-          - github.com/oasisprotocol
-          - google.golang.org/grpc
-          - github.com/ethereum/go-ethereum
-          - github.com/stretchr/testify
-          - github.com/uptrace/bun
-          - github.com/gorilla
-          - github.com/prometheus
-          - github.com/knadh/koanf
-          - github.com/rs/cors
-          - github.com/spf13/cobra
+      # Exclude some linters on test files.
+      - linters:
+          - govet
+          - revive
+          - gosec
+          - errcheck
+        path: (.+)_test\.go
+      - linters:
+          - govet
+          - revive
+          - gosec
+        path: tests/*
+      # Exclude var-naming.
+      - linters:
+          - revive
+        text: var-naming
+      # Exclude sttutering.
+      - linters:
+          - revive
+        text: and that stutters
+      # Exclude unused parameters.
+      - linters:
+          - revive
+        text: unused-parameter
+      # Exclude required comments on exported structs/fields.
+      - linters:
+          - revive
+        text: "exported:"
+      # Exclude could apply De Morgan's law.
+      - linters:
+          - staticcheck
+        text: QF1001
+      # Exclude could remove embedded fields.
+      - linters:
+          - staticcheck
+        text: QF1008
+      # Exclude intiger overflow conversion.
+      - linters:
+          - gosec
+        text: G115
+      # Exclude audited unsafe calls.
+      - linters:
+          - gosec
+        text: G103
+
+formatters:
+  enable:
+    - gofumpt
+    - goimports
+  settings:
+    goimports:
+      local-prefixes:
+        - github.com/oasisprotocol/
diff --git a/conf/config.go b/conf/config.go
@@ -1,3 +1,4 @@
+// Package conf provides the configuration for the Oasis Web3 Gateway.
 package conf
 
 import (
diff --git a/db/migrations/migrations.go b/db/migrations/migrations.go
@@ -1,3 +1,4 @@
+// Package migrations provides database migrations for the Oasis Web3 Gateway.
 package migrations
 
 import (
diff --git a/db/migrator/migrator.go b/db/migrator/migrator.go
@@ -61,10 +61,7 @@ func (m *Migrator) Migrate(ctx context.Context) error {
 		return fmt.Errorf("no migrations")
 	}
 	var stop bool
-	for {
-		if stop {
-			break
-		}
+	for !stop {
 		// Apply next migration in a transaction.
 		if err := m.db.RunInTx(ctx, nil, func(ctx context.Context, tx bun.Tx) error {
 			// Lock migrations table for the transaction duration.
diff --git a/db/model/model.go b/db/model/model.go
@@ -1,3 +1,4 @@
+// Package model defines the database models used in the application.
 package model
 
 // AccessTuple is the element of an AccessList.
diff --git a/filters/types.go b/filters/types.go
@@ -1,3 +1,4 @@
+// Package filters defines the filtering event system.
 package filters
 
 import (
diff --git a/indexer/backend.go b/indexer/backend.go
@@ -1,3 +1,4 @@
+// Package indexer provides the indexer backend implementation.
 package indexer
 
 import (
diff --git a/log/log.go b/log/log.go
@@ -1,3 +1,4 @@
+// Package log provides logging functionality for the Oasis Web3 Gateway.
 package log
 
 import (
diff --git a/main.go b/main.go
@@ -1,3 +1,4 @@
+// Package main implements the main entry point for the Oasis Web3 Gateway.
 package main
 
 import (
@@ -210,7 +211,7 @@ func runRoot() error {
 		logger.Error("failed to establish connection", "err", err)
 		return err
 	}
-	defer conn.Close()
+	defer conn.Close() // nolint:errcheck
 
 	// Create the runtime client with account module query helpers.
 	rc := client.New(conn, runtimeID)
@@ -305,7 +306,7 @@ func runRoot() error {
 
 		<-sigc
 		logger.Info("Got interrupt, shutting down...")
-		go svr.Close()
+		go svr.Close() //nolint:errcheck
 		go indx.Stop()
 		go gasPriceOracle.Stop()
 	}()
diff --git a/rpc/apis.go b/rpc/apis.go
@@ -1,3 +1,4 @@
+// Package rpc provides the Web3 JSON-RPC APIs for the Oasis Web3 Gateway.
 package rpc
 
 import (
diff --git a/rpc/eth/api.go b/rpc/eth/api.go
@@ -1,3 +1,4 @@
+// Package eth provides the Web3 JSON-RPC Ethereum API.
 package eth
 
 import (
diff --git a/rpc/eth/filters/api.go b/rpc/eth/filters/api.go
@@ -1,3 +1,4 @@
+// Package filters implements the eth filtering Web3 JSON-RPC API.
 package filters
 
 import (
diff --git a/rpc/eth/metrics/api.go b/rpc/eth/metrics/api.go
@@ -1,3 +1,4 @@
+// Package metrics provides instrumentation for the Web3 Gateway API.
 package metrics
 
 import (
diff --git a/rpc/metrics/metrics.go b/rpc/metrics/metrics.go
@@ -1,3 +1,4 @@
+// Package metrics provides Prometheus metrics for the API.
 package metrics
 
 import (
diff --git a/rpc/net/api.go b/rpc/net/api.go
@@ -1,3 +1,4 @@
+// Package net provides the Web3 JSON-RPC Net API.
 package net
 
 import (
diff --git a/rpc/oasis/api.go b/rpc/oasis/api.go
@@ -1,3 +1,4 @@
+// Package oasis provides the Oasis Web3 JSON-RPC API.
 package oasis
 
 import (
diff --git a/rpc/txpool/api.go b/rpc/txpool/api.go
@@ -1,3 +1,4 @@
+// Package txpool provides the Web3 JSON-RPC txpool API.
 package txpool
 
 // API is the txpool_ prefixed set of APIs in the Web3 JSON-RPC spec.
diff --git a/rpc/utils/types.go b/rpc/utils/types.go
@@ -1,3 +1,4 @@
+// Package utils provides the utility types and functions for RPC API.
 package utils
 
 import (
diff --git a/rpc/web3/api.go b/rpc/web3/api.go
@@ -1,3 +1,4 @@
+// Package web3 provides the Web3 JSON-RPC API implementation for the Oasis Web3 Gateway.
 package web3
 
 import (
diff --git a/server/json_rpc.go b/server/json_rpc.go
@@ -1,3 +1,4 @@
+// Package server implements the JSON RPC server for the Oasis Web3 Gateway.
 package server
 
 import (
diff --git a/server/server.go b/server/server.go
@@ -162,7 +162,7 @@ func (srv *Web3Gateway) Start() error {
 
 	// Check if RPC endpoint startup failed.
 	if err != nil {
-		srv.doClose(nil)
+		_ = srv.doClose(nil)
 		return err
 	}
 
diff --git a/storage/psql/metrics.go b/storage/psql/metrics.go
@@ -1,3 +1,4 @@
+// Package psql provides PostgreSQL storage with Prometheus metrics for the Oasis Web3 Gateway.
 package psql
 
 import (
diff --git a/storage/types.go b/storage/types.go
@@ -1,3 +1,4 @@
+// Package storage defines the interface for the storage layer of the Oasis Web3 Gateway.
 package storage
 
 import (
diff --git a/tests/rpc/utils.go b/tests/rpc/utils.go
@@ -185,7 +185,7 @@ func Setup() error {
 	w3.RegisterHealthChecks(checks)
 
 	if err = w3.Start(); err != nil {
-		w3.Close()
+		_ = w3.Close()
 		return fmt.Errorf("setup: failed to start server: %w", err)
 	}
 
diff --git a/version/version.go b/version/version.go
@@ -1,3 +1,4 @@
+// Package version provides the version information for the Oasis Web3 Gateway.
 package version
 
 import (

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+// Package conf provides the configuration for the Oasis Web3 Gateway.`
`1`	`2`	`package conf`
`2`	`3`
`3`	`4`	`import (`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+// Package migrations provides database migrations for the Oasis Web3 Gateway.`
`1`	`2`	`package migrations`
`2`	`3`
`3`	`4`	`import (`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+// Package model defines the database models used in the application.`
`1`	`2`	`package model`
`2`	`3`
`3`	`4`	`// AccessTuple is the element of an AccessList.`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+// Package filters defines the filtering event system.`
`1`	`2`	`package filters`
`2`	`3`
`3`	`4`	`import (`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+// Package indexer provides the indexer backend implementation.`
`1`	`2`	`package indexer`
`2`	`3`
`3`	`4`	`import (`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+// Package log provides logging functionality for the Oasis Web3 Gateway.`
`1`	`2`	`package log`
`2`	`3`
`3`	`4`	`import (`