Configure path prefix via processor abstraction #1226

jwilner · 2020-07-10T02:19:03Z

Meant as an alternative to #1225 which uses the standard processor abstraction

problem

It's often convenient in monorepos to run a tool from a different directory but still report issues relative to the root of the repository.

This is exactly the problem in the github action golangci/golangci-lint-action#31

proposed solution

Add a flag for specifying a path prefix in output. Default behavior remains the same.

Thanks for a great tool!

pkg/result/processors/path_prefixer.go

pkg/lint/runner.go

pkg/commands/run.go

jwilner

Well these checks are just wrong (the scope lint ones)

jwilner · 2020-07-10T04:20:17Z

Will squash merge away noise

SVilgelm · 2020-07-10T04:27:05Z

Will squash merge away noise

no worries, it's only one allowed option to merge any pull requests here.

SVilgelm · 2020-07-10T04:28:51Z

Since it adds a new config option, could you also add a test in the test/run_test.go?

sayboras · 2020-07-10T04:34:42Z

pkg/result/processors/path_prefixer.go

+
+// Process adds the prefix to each path
+func (p *PathPrefixer) Process(issues []result.Issue) ([]result.Issue, error) {
+	if p.prefix != "" {


The current logic seems fine to me.

Just a note on immutability, I just take a look at existing implementation of processors. Seems like https://github.com/golangci/golangci-lint/blob/master/pkg/result/processors/utils.go#L40 is widely used (this function create a copy of slides).

What do you think ?

Well, it's safe for this to be mutating the passed in slice because, by definition, the processors happen serially, so there's no risk of a race on the mutated memory.

I would guess the transformSlices function exists because it's easy to mess up working with a slice of values -- every value in a range loop is a copy, etc, etc.

As it is, I figured this is a memory-sensitive application and the Issue struct is non-trivial in its size, so I'd avoid the unnecessary copies and alloc.

Without running any sort of measurements, I'm guessing there's a lot of fat around this processor chain's memory usage and shifting to a pattern like that I've used here would cut it down a bunch.

pkg/result/processors/path_prefixer_test.go

jwilner · 2020-07-10T13:02:53Z

Will squash merge away noise

no worries, it's only one allowed option to merge any pull requests here.

The only civilized option! :)

jwilner · 2020-07-10T13:19:56Z

@SVilgelm added to run_test.go per your request.

I'm impressed with this project's test coverage. 👍

SVilgelm

Thank you! Looks good to me.

jwilner · 2020-07-10T14:23:50Z

🥳 looking forward to using it :)

jwilner · 2020-07-10T15:13:34Z

Oh I don't have the ability to merge btw, if that was ambiguous.

SVilgelm · 2020-07-10T18:04:54Z

Let's wait a feedback from @sayboras, he also revised this PR

sayboras

LGTM 👍

golangci-automator · 2020-07-10T23:15:17Z

Hey, @jwilner — we just merged your PR to golangci-lint! 🔥🚀

golangci-lint is built by awesome people like you. Let us say “thanks”: we just invited you to join the GolangCI organization on GitHub.
This will add you to our team of maintainers. Accept the invite by visiting this link.

By joining the team, you’ll be able to label issues, review pull requests, and merge approved pull requests.
More information about contributing is here.

Thanks again!

sayboras · 2020-07-10T23:49:59Z

It's wierd that test failed in master https://github.com/golangci/golangci-lint/runs/859811449 and another one #1201

@jwilner Do you have any idea or pointer ?

jwilner · 2020-07-11T00:14:30Z

@sayboras whoa, huh, one of the tests I added!? I'd be happy to look -- but I can't tell which test it is from the output. Can you point me in the right direction?

SVilgelm · 2020-07-11T00:16:27Z

@jwilner Here it is: https://github.com/golangci/golangci-lint/runs/859880992?check_suite_focus=true#step:5:881

jwilner · 2020-07-11T00:39:39Z

So something about the test runner is failing on the command

../golangci-lint run --allow-parallel-runners --path-prefix=cool testdata/withTests

Isn't the test dir testdata/withTests used within other tests? Hmmm. Digging deeper.

=== RUN   TestPathPrefix/prefixed
level=info msg="[test] stderr: "
level=info msg="[test] ran [../golangci-lint run --allow-parallel-runners --path-prefix=cool testdata/withTests] in 358.830342ms"
    TestPathPrefix/prefixed: testshared.go:71: 
        	Error Trace:	testshared.go:71
        	            				run_test.go:308
        	Error:      	Expect "level=error msg="Running error: context loading failed: failed to load packages: cannot find package \".\" in:\n\t/home/runner/work/golangci-lint/golangci-lint/test/testdata/withTests: failed to analyze"
        	            	" to match "^cool/testdata/withTests"
        	Test:       	TestPathPrefix/prefixed
        	Messages:   	exit code is 3

jwilner · 2020-07-11T03:06:29Z

@SVilgelm @sayboras I've opened up a fix here if you want to check it out: #1229

SVilgelm · 2020-07-11T03:10:51Z

@jwilner thank you, I merged it to unblock the CI

Configure path prefix via processor abstraction

4f6992d

sayboras mentioned this pull request Jul 10, 2020

Add ability to specify path prefix in output #1225

Closed

sayboras reviewed Jul 10, 2020

View reviewed changes

pkg/result/processors/path_prefixer.go Show resolved Hide resolved

sayboras reviewed Jul 10, 2020

View reviewed changes

pkg/lint/runner.go Show resolved Hide resolved

Adds a simple unit

b68ee0d

sayboras reviewed Jul 10, 2020

View reviewed changes

pkg/commands/run.go Show resolved Hide resolved

jwilner commented Jul 10, 2020

View reviewed changes

jwilner and others added 2 commits July 10, 2020 00:12

Skip incorrect lint messages

0ed243c

No more editing in github browser

c0121d5

SVilgelm mentioned this pull request Jul 10, 2020

Setting workdir breaks GitHub action annotations golangci/golangci-lint-action#31

Closed

sayboras reviewed Jul 10, 2020

View reviewed changes

sayboras requested a review from a team July 10, 2020 04:35

sayboras reviewed Jul 10, 2020

View reviewed changes

pkg/result/processors/path_prefixer_test.go Show resolved Hide resolved

sayboras requested a review from a team July 10, 2020 10:56

run_test additions

2dca06e

jwilner mentioned this pull request Jul 10, 2020

Add path prefix if working directory specified golangci/golangci-lint-action#34

Merged

SVilgelm approved these changes Jul 10, 2020

View reviewed changes

SVilgelm changed the title ~~Alternative: Configure path prefix via processor abstraction~~ Configure path prefix via processor abstraction Jul 10, 2020

SVilgelm requested review from sayboras and a team July 10, 2020 18:05

sayboras approved these changes Jul 10, 2020

View reviewed changes

sayboras merged commit 6550984 into golangci:master Jul 10, 2020

jwilner mentioned this pull request Jul 11, 2020

Use lowercase directories to fix test #1229

Merged

ldez added this to the v1.28 milestone Mar 6, 2024

ldez mentioned this pull request Jan 13, 2025

🌟 Let's talk about exclusion options inside issues section #5297

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Configure path prefix via processor abstraction #1226

Configure path prefix via processor abstraction #1226

jwilner commented Jul 10, 2020

jwilner left a comment •

edited

Loading

jwilner commented Jul 10, 2020

SVilgelm commented Jul 10, 2020

SVilgelm commented Jul 10, 2020

sayboras Jul 10, 2020

jwilner Jul 10, 2020 •

edited

Loading

jwilner commented Jul 10, 2020

jwilner commented Jul 10, 2020

SVilgelm left a comment

jwilner commented Jul 10, 2020

jwilner commented Jul 10, 2020

SVilgelm commented Jul 10, 2020

sayboras left a comment

golangci-automator bot commented Jul 10, 2020

sayboras commented Jul 10, 2020

jwilner commented Jul 11, 2020

SVilgelm commented Jul 11, 2020

jwilner commented Jul 11, 2020

jwilner commented Jul 11, 2020

SVilgelm commented Jul 11, 2020

Configure path prefix via processor abstraction #1226

Configure path prefix via processor abstraction #1226

Conversation

jwilner commented Jul 10, 2020

problem

proposed solution

jwilner left a comment • edited Loading

Choose a reason for hiding this comment

jwilner commented Jul 10, 2020

SVilgelm commented Jul 10, 2020

SVilgelm commented Jul 10, 2020

sayboras Jul 10, 2020

Choose a reason for hiding this comment

jwilner Jul 10, 2020 • edited Loading

Choose a reason for hiding this comment

jwilner commented Jul 10, 2020

jwilner commented Jul 10, 2020

SVilgelm left a comment

Choose a reason for hiding this comment

jwilner commented Jul 10, 2020

jwilner commented Jul 10, 2020

SVilgelm commented Jul 10, 2020

sayboras left a comment

Choose a reason for hiding this comment

golangci-automator bot commented Jul 10, 2020

sayboras commented Jul 10, 2020

jwilner commented Jul 11, 2020

SVilgelm commented Jul 11, 2020

jwilner commented Jul 11, 2020

jwilner commented Jul 11, 2020

SVilgelm commented Jul 11, 2020

jwilner left a comment •

edited

Loading

jwilner Jul 10, 2020 •

edited

Loading