chore/linter

.github/actions/go-check-setup/action.yml

@@ -13,8 +13,13 @@ runs:
         restore-keys: |
           ${{ matrix.os }}-golang-${{ matrix.go }}-
 
+    - name: Setup Go
+      uses: actions/setup-go@v5
+      with:
+        go-version-file: 'go.mod'
+
     - name: Lint
-      uses: golangci/golangci-lint-action@v3
+      uses: golangci/golangci-lint-action@v7
       with:
-        version: v1.55.2
+        version: v2.1.5
         args: --timeout=10m

.github/workflows/auto-generate.yml

@@ -13,9 +13,9 @@ jobs:
         ref: ${{ github.head_ref }}
 
     - name: Setup Go
-      uses: actions/setup-go@v4
+      uses: actions/setup-go@v5
       with:
-        go-version: '1.20.x'
+        go-version-file: 'go.mod'
 
     - name: Run go generate
       run: |

.github/workflows/go-check.yml

@@ -15,4 +15,4 @@ concurrency:
 
 jobs:
   go-check:
-    uses: ipdxco/unified-github-workflows/.github/workflows/[email protected].17
+    uses: ipdxco/unified-github-workflows/.github/workflows/[email protected].22

.github/workflows/release-binaries.yml

@@ -16,9 +16,9 @@ jobs:
         with:
           fetch-depth: 0
       - name: Set up Go
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
         with:
-          go-version: "1.20.x"
+          go-version-file: 'go.mod'
       - name: Release Binaries
         uses: goreleaser/goreleaser-action@v4
         with:

.gitignore

@@ -21,6 +21,8 @@
 /baga*
 singularity.db*
 
+# Devcontainer
+.devcontainer/
 
 node_modules
 /.pnp

.golangci.yml

@@ -1,76 +1,87 @@
-run:
-  tests: false
-  skip-dirs:
-    - replication/internal
-    - cmd/embed
-    - docs
-    - dashboard/model2ts
-    - handler/datasource/generate
-    - handler/storage/gen
-  skip-files:
-    - cmd/testutil.go
-
-linters:
-  enable-all: true
-  disable:
-    - typecheck
-    - interfacer
-    - structcheck
-    - golint
-    - ifshort
-    - scopelint
-    - varcheck
-    - varnamelen
-    - maligned
-    - deadcode
-    - structcheck
-    - gci
-    - goimports
-    - gofumpt
-    - nolintlint
-    - ireturn
-    - nosnakecase
-    - nlreturn
-    - godox
-    - gomoddirectives
-    - rowserrcheck
-    - sqlclosecheck
-    - wastedassign
-    - gocognit
-    - wsl
-    - musttag
-    - exhaustivestruct
-    - cyclop
-    - gomnd
-    - gochecknoglobals
-    - funlen
-    - gocyclo
-    - exhaustruct
-    - wrapcheck
-    - nestif
-    - containedctx
-    - maintidx
-    - nonamedreturns
-    - nilnil
-    - prealloc
-    - gochecknoinits
-    - dupl
-    - forbidigo
-    - godot
-    - depguard
-    - nakedret
-    - tagalign
-    - lll
-    - dupword
-    - interfacebloat
-    - goconst
-
-linters-settings:
-  errcheck:
-    exclude-functions:
-      - (github.com/libp2p/go-libp2p/network.MuxedStream).SetDeadline
-      - (github.com/data-preservation-programs/singularity/service.DatasetWorker).cleanup
-  revive:
-    rules:
-      - name: var-naming
-        disabled: true
+version: "2"
+run:
+  tests: false
+linters:
+  default: all
+  disable:
+    - containedctx
+    - cyclop
+    - depguard
+    - dupl
+    - dupword
+    - exhaustruct
+    - forbidigo
+    - funlen
+    - gochecknoglobals
+    - gochecknoinits
+    - gocognit
+    - goconst
+    - gocyclo
+    - godot
+    - godox
+    - gomoddirectives
+    - interfacebloat
+    - ireturn
+    - lll
+    - maintidx
+    - mnd
+    - musttag
+    - nakedret
+    - nestif
+    - nilnil
+    - nlreturn
+    - nolintlint
+    - nonamedreturns
+    - prealloc
+    - rowserrcheck
+    - sqlclosecheck
+    - tagalign
+    - varnamelen
+    - wastedassign
+    - wrapcheck
+    - wsl
+    - contextcheck
+    - forcetypeassert
+    - funcorder
+    - exhaustive
+    - intrange
+  settings:
+    gosec:
+      excludes:
+        - G115 # we do a lot of uint64 conversions unfortunately
+    errcheck:
+      exclude-functions:
+        - path/filepath.Walk
+        - (github.com/libp2p/go-libp2p/network.MuxedStream).SetDeadline
+        - (github.com/data-preservation-programs/singularity/service.DatasetWorker).cleanup
+    revive:
+      rules:
+        - name: var-naming
+          disabled: true
+    recvcheck:
+      disable-builtin: true
+      exclusions:
+        - "*.Value"
+        - "*.String"
+        - "*.MarshalBinary"
+        - "*.MarshalJSON"
+  exclusions:
+    generated: lax
+    presets:
+      - comments
+      - common-false-positives
+      - legacy
+      - std-error-handling
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
+formatters:
+  enable:
+    - gofmt
+  exclusions:
+    generated: lax
+    paths:
+      - third_party$
+      - builtin$
+      - examples$

Makefile

@@ -13,8 +13,8 @@ check-go:
 	@which go > /dev/null || (echo "Go is not installed. Please install Go." && exit 1)
 
 install-lint-deps:
-	@which golangci-lint > /dev/null || (echo "Required golangci-lint not found. Installing it..." && GO111MODULE=on go get github.com/golangci/golangci-lint/cmd/golangci-lint@latest)
-	@which staticcheck > /dev/null || (echo "Required staticcheck not found. Installing it..." && GO111MODULE=on go get honnef.co/go/tools/cmd/staticcheck)
+	@which golangci-lint > /dev/null || (echo "Required golangci-lint not found. Installing it..." && go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest)
+	@which staticcheck > /dev/null || (echo "Required staticcheck not found. Installing it..." && go install honnef.co/go/tools/cmd/staticcheck@latest)
 
 install-test-deps:
 	@which gotestsum > /dev/null || (echo "Installing gotestsum..." && GO111MODULE=on go get gotest.tools/gotestsum@latest)
@@ -29,8 +29,10 @@ generate: check-go
 	go generate ./...
 
 lint: check-go install-lint-deps
+	@echo "Verifying golangci-lint configuration..."
+	golangci-lint config verify
 	gofmt -s -w .
-	golangci-lint run --no-config --fix --disable-all -E tagalign --timeout 10m
+	golangci-lint run --no-config --fix --default=none -E tagalign --timeout 10m
 	golangci-lint run --fix --timeout 10m
 	staticcheck ./...
 

analytics/analytics.go

@@ -63,8 +63,10 @@ func Init(ctx context.Context, db *gorm.DB) error {
 	return nil
 }
 
-var Instance string
-var Identity string
+var (
+	Instance string
+	Identity string
+)
 
 type Collector struct {
 	mu            sync.Mutex

api/api.go

@@ -11,7 +11,10 @@ import (
 	"strconv"
 	"time"
 
+	"github.com/cockroachdb/errors"
 	"github.com/data-preservation-programs/singularity/analytics"
+	"github.com/data-preservation-programs/singularity/database"
+	_ "github.com/data-preservation-programs/singularity/docs/swagger"
 	"github.com/data-preservation-programs/singularity/handler/admin"
 	"github.com/data-preservation-programs/singularity/handler/dataprep"
 	"github.com/data-preservation-programs/singularity/handler/deal"
@@ -29,17 +32,13 @@ import (
 	"github.com/data-preservation-programs/singularity/service/contentprovider"
 	"github.com/data-preservation-programs/singularity/util"
 	"github.com/filecoin-project/lassie/pkg/lassie"
-	"github.com/libp2p/go-libp2p/core/host"
-	"github.com/ybbus/jsonrpc/v3"
-
-	"github.com/cockroachdb/errors"
-	"github.com/data-preservation-programs/singularity/database"
-	_ "github.com/data-preservation-programs/singularity/docs/swagger"
 	logging "github.com/ipfs/go-log/v2"
 	"github.com/labstack/echo/v4"
 	"github.com/labstack/echo/v4/middleware"
+	"github.com/libp2p/go-libp2p/core/host"
 	echoSwagger "github.com/swaggo/echo-swagger"
 	"github.com/urfave/cli/v2"
+	"github.com/ybbus/jsonrpc/v3"
 	"gorm.io/gorm"
 )
 
@@ -61,7 +60,7 @@ type Server struct {
 	scheduleHandler schedule.Handler
 }
 
-func (s Server) Name() string {
+func (s *Server) Name() string {
 	return "api"
 }
 
@@ -75,7 +74,7 @@ func (s Server) Name() string {
 // @Failure 404 {string} string "Not Found"
 // @Failure 500 {string} string "Internal Server Error"
 // @Router /piece/{id}/metadata [get]
-func (s Server) getMetadataHandler(c echo.Context) error {
+func (s *Server) getMetadataHandler(c echo.Context) error {
 	return contentprovider.GetMetadataHandler(c, s.db)
 }
 
@@ -112,18 +111,18 @@ type APIParams struct {
 	ConnString string
 }
 
-func InitServer(ctx context.Context, params APIParams) (Server, error) {
+func InitServer(ctx context.Context, params APIParams) (*Server, error) {
 	db, closer, err := database.OpenWithLogger(params.ConnString)
 	if err != nil {
-		return Server{}, errors.WithStack(err)
+		return nil, errors.WithStack(err)
 	}
 	h, err := util.InitHost(nil)
 	if err != nil {
-		return Server{}, errors.Wrap(err, "failed to init host")
+		return nil, errors.Wrap(err, "failed to init host")
 	}
 	lassie, err := lassie.NewLassie(ctx, lassie.WithHost(h))
 	if err != nil {
-		return Server{}, errors.Wrap(err, "failed to init lassie")
+		return nil, errors.Wrap(err, "failed to init lassie")
 	}
 	infoFetcher := replication.MinerInfoFetcher{
 		Client: util.NewLotusClient(params.LotusAPI, params.LotusToken),
@@ -136,7 +135,7 @@ func InitServer(ctx context.Context, params APIParams) (Server, error) {
 		endpointfinder.WithErrorLruSize(128),
 		endpointfinder.WithErrorLruTimeout(time.Minute*5),
 	)
-	return Server{
+	return &Server{
 		db:          db,
 		host:        h,
 		listener:    params.Listener,
@@ -184,7 +183,7 @@ func InitServer(ctx context.Context, params APIParams) (Server, error) {
 // This method assumes a specific ordering and kind of parameters in the handler functions.
 // It is designed to simplify the process of defining Echo handlers but has limitations
 // in terms of the variety of supported handler function signatures.
-func (s Server) toEchoHandler(handlerFunc any) echo.HandlerFunc {
+func (s *Server) toEchoHandler(handlerFunc any) echo.HandlerFunc {
 	return func(c echo.Context) error {
 		handlerFuncValue := reflect.ValueOf(handlerFunc)
 		handlerFuncType := handlerFuncValue.Type()
@@ -295,7 +294,7 @@ func (s Server) toEchoHandler(handlerFunc any) echo.HandlerFunc {
 	}
 }
 
-func (s Server) setupRoutes(e *echo.Echo) {
+func (s *Server) setupRoutes(e *echo.Echo) {
 	// Admin
 	e.POST("/api/identity", s.toEchoHandler(s.adminHandler.SetIdentityHandler))
 	// Storage
@@ -402,7 +401,7 @@ var logger = logging.Logger("api")
 //     3. Completion of analytics event flushing.
 //   - A channel (service.Fail) that reports errors that occur while the server is running.
 //   - An error if there is an issue during the initialization phase, otherwise nil.
-func (s Server) Start(ctx context.Context, exitErr chan<- error) error {
+func (s *Server) Start(ctx context.Context, exitErr chan<- error) error {
 	err := analytics.Init(ctx, s.db)
 	if err != nil {
 		return errors.WithStack(err)

cmd/download.go

@@ -1,6 +1,8 @@
 package cmd
 
 import (
+	"slices"
+
 	"github.com/cockroachdb/errors"
 	"github.com/data-preservation-programs/singularity/cmd/cliutil"
 	"github.com/data-preservation-programs/singularity/cmd/storage"
@@ -9,7 +11,6 @@ import (
 	"github.com/data-preservation-programs/singularity/storagesystem"
 	"github.com/ipfs/go-log"
 	"github.com/urfave/cli/v2"
-	"golang.org/x/exp/slices"
 )
 
 var DownloadCmd = &cli.Command{

cmd/ez/prep.go

@@ -94,7 +94,7 @@ var PrepCmd = &cli.Command{
 		outputDir := c.String("output-dir")
 		var outputStorages []string
 		if outputDir != "" {
-			err = os.MkdirAll(outputDir, 0755)
+			err = os.MkdirAll(outputDir, 0o755)
 			if err != nil {
 				return errors.Wrap(err, "failed to create output directory")
 			}