refactor: create PathAbsoluter

Author: ldez

pkg/lint/runner.go

@@ -68,12 +68,15 @@ func NewRunner(log logutils.Log, cfg *config.Config, args []string, goenv *gouti
 
 	return &Runner{
 		Processors: []processors.Processor{
+			// Must be the first processor.
+			processors.NewPathAbsoluter(log),
+
 			processors.NewCgo(goenv),
 
-			// Must go after Cgo.
+			// Must be after Cgo.
 			processors.NewFilenameUnadjuster(lintCtx.Packages, log.Child(logutils.DebugKeyFilenameUnadjuster)),
 
-			// Must go after FilenameUnadjuster.
+			// Must be after FilenameUnadjuster.
 			processors.NewInvalidIssue(log.Child(logutils.DebugKeyInvalidIssue)),
 
 			// Must be before diff, nolint and exclude autogenerated processor at least.

pkg/logutils/logutils.go

@@ -36,6 +36,7 @@ const (
 	DebugKeyLoader             = "loader" // Debugs packages loading (including `go/packages` internal debugging).
 	DebugKeyMaxFromLinter      = "max_from_linter"
 	DebugKeyMaxSameIssues      = "max_same_issues"
+	DebugKeyPathAbsoluter      = "path_absoluter"
 	DebugKeyPkgCache           = "pkgcache"
 	DebugKeyRunner             = "runner"
 	DebugKeySeverityRules      = "severity_rules"

pkg/result/processors/cgo.go

@@ -1,7 +1,6 @@
 package processors
 
 import (
-	"fmt"
 	"path/filepath"
 	"strings"
 
@@ -11,6 +10,10 @@ import (
 
 var _ Processor = (*Cgo)(nil)
 
+// Cgo some linters (e.g. gosec, deadcode) return incorrect filepaths for cgo issues,
+// also cgo files have strange issues looking like false positives.
+//
+// Require absolute filepath.
 type Cgo struct {
 	goCacheDir string
 }
@@ -21,32 +24,19 @@ func NewCgo(goenv *goutil.Env) *Cgo {
 	}
 }
 
-func (Cgo) Name() string {
+func (*Cgo) Name() string {
 	return "cgo"
 }
 
-func (p Cgo) Process(issues []result.Issue) ([]result.Issue, error) {
+func (p *Cgo) Process(issues []result.Issue) ([]result.Issue, error) {
 	return filterIssuesErr(issues, p.shouldPassIssue)
 }
 
-func (Cgo) Finish() {}
+func (*Cgo) Finish() {}
 
-func (p Cgo) shouldPassIssue(issue *result.Issue) (bool, error) {
-	// some linters (e.g. gosec, deadcode) return incorrect filepaths for cgo issues,
-	// also cgo files have strange issues looking like false positives.
-
-	// cache dir contains all preprocessed files including cgo files
-
-	issueFilePath := issue.FilePath()
-	if !filepath.IsAbs(issue.FilePath()) {
-		absPath, err := filepath.Abs(issue.FilePath())
-		if err != nil {
-			return false, fmt.Errorf("failed to build abs path for %q: %w", issue.FilePath(), err)
-		}
-		issueFilePath = absPath
-	}
-
-	if p.goCacheDir != "" && strings.HasPrefix(issueFilePath, p.goCacheDir) {
+func (p *Cgo) shouldPassIssue(issue *result.Issue) (bool, error) {
+	// [p.goCacheDir] contains all preprocessed files including cgo files.
+	if p.goCacheDir != "" && strings.HasPrefix(issue.FilePath(), p.goCacheDir) {
 		return false, nil
 	}
 

pkg/result/processors/filename_unadjuster.go

@@ -3,7 +3,6 @@ package processors
 import (
 	"go/parser"
 	"go/token"
-	"path/filepath"
 	"strings"
 	"sync"
 	"time"
@@ -23,9 +22,11 @@ type adjustMap struct {
 	m map[string]posMapper
 }
 
-// FilenameUnadjuster is needed because a lot of linters use fset.Position(f.Pos())
-// to get filename. And they return adjusted filename (e.g. *.qtpl) for an issue. We need
-// restore real .go filename to properly output it, parse it, etc.
+// FilenameUnadjuster is needed because a lot of linters use `fset.Position(f.Pos())` to get filename.
+// And they return adjusted filename (e.g.` *.qtpl`) for an issue.
+// We need restore real `.go` filename to properly output it, parse it, etc.
+//
+// Require absolute filepath.
 type FilenameUnadjuster struct {
 	m                   map[string]posMapper // map from adjusted filename to position mapper: adjusted -> unadjusted position
 	log                 logutils.Log
@@ -36,16 +37,20 @@ func NewFilenameUnadjuster(pkgs []*packages.Package, log logutils.Log) *Filename
 	m := adjustMap{m: map[string]posMapper{}}
 
 	startedAt := time.Now()
+
 	var wg sync.WaitGroup
 	wg.Add(len(pkgs))
+
 	for _, pkg := range pkgs {
 		go func(pkg *packages.Package) {
 			// It's important to call func here to run GC
 			processUnadjusterPkg(&m, pkg, log)
 			wg.Done()
 		}(pkg)
 	}
+
 	wg.Wait()
+
 	log.Infof("Pre-built %d adjustments in %s", len(m.m), time.Since(startedAt))
 
 	return &FilenameUnadjuster{
@@ -61,17 +66,7 @@ func (*FilenameUnadjuster) Name() string {
 
 func (p *FilenameUnadjuster) Process(issues []result.Issue) ([]result.Issue, error) {
 	return transformIssues(issues, func(issue *result.Issue) *result.Issue {
-		issueFilePath := issue.FilePath()
-		if !filepath.IsAbs(issue.FilePath()) {
-			absPath, err := filepath.Abs(issue.FilePath())
-			if err != nil {
-				p.log.Warnf("failed to build abs path for %q: %s", issue.FilePath(), err)
-				return issue
-			}
-			issueFilePath = absPath
-		}
-
-		mapper := p.m[issueFilePath]
+		mapper := p.m[issue.FilePath()]
 		if mapper == nil {
 			return issue
 		}

pkg/result/processors/path_absoluter.go

@@ -0,0 +1,44 @@
+package processors
+
+import (
+	"path/filepath"
+
+	"github.com/golangci/golangci-lint/pkg/logutils"
+	"github.com/golangci/golangci-lint/pkg/result"
+)
+
+var _ Processor = (*PathAbsoluter)(nil)
+
+// PathAbsoluter ensures that representation of path are absolute.
+type PathAbsoluter struct {
+	log logutils.Log
+}
+
+func NewPathAbsoluter(log logutils.Log) *PathAbsoluter {
+	return &PathAbsoluter{log: log.Child(logutils.DebugKeyPathAbsoluter)}
+}
+
+func (*PathAbsoluter) Name() string {
+	return "path_absoluter"
+}
+
+func (p *PathAbsoluter) Process(issues []result.Issue) ([]result.Issue, error) {
+	return transformIssues(issues, func(issue *result.Issue) *result.Issue {
+		if filepath.IsAbs(issue.FilePath()) {
+			return issue
+		}
+
+		absPath, err := filepath.Abs(issue.FilePath())
+		if err != nil {
+			p.log.Warnf("failed to get absolute path for %q: %v", issue.FilePath(), err)
+			return nil
+		}
+
+		newIssue := issue
+		newIssue.Pos.Filename = absPath
+
+		return newIssue
+	}), nil
+}
+
+func (*PathAbsoluter) Finish() {}