feat: replace multierror with stdlib errors wrapping #41043

kruskall · 2024-09-29T22:18:12Z

Proposed commit message

replace multierror library with stdlib error wrapping

Go 1.20 added errors.Join allowing for multierrors. Replace go-multierror usage with native go errors

Checklist

My code follows the style guidelines of this project
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
I have made corresponding change to the default configuration files
I have added tests that prove my fix is effective or that my feature works
I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Disruptive User Impact

Author's Checklist

[ ]

How to test this PR locally

Related issues

Use cases

Screenshots

Logs

replace multierror library with stdlib error wrapping

mergify · 2024-09-29T22:18:51Z

This pull request does not have a backport label.
If this is a bug or security fix, could you label this PR @kruskall? 🙏.
For such, you'll need to label your PR with:

The upcoming major version of the Elastic Stack
The upcoming minor version of the Elastic Stack (if you're not pushing a breaking change)

To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

backport-8./d is the label to automatically backport to the 8./d branch. /d is the digit

mergify · 2024-09-29T22:18:52Z

backport-8.x has been added to help with the transition to the new branch 8.x.
If you don't need it please use backport-skip label and remove the backport-8.x label.

shmsr · 2024-09-30T10:03:03Z

@kruskall can we also remove the use of "github.com/pkg/errors"?

elasticmachine · 2024-09-30T12:33:05Z

Pinging @elastic/sec-windows-platform (Team:Security-Windows Platform)

elasticmachine · 2024-09-30T12:33:05Z

Pinging @elastic/elastic-agent-data-plane (Team:Elastic-Agent-Data-Plane)

elasticmachine · 2024-09-30T12:33:05Z

Pinging @elastic/sec-linux-platform (Team:Security-Linux Platform)

mergify · 2024-09-30T21:05:04Z

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b feat/drop-multierror upstream/feat/drop-multierror
git merge upstream/main
git push upstream feat/drop-multierror

kruskall · 2024-09-30T21:23:16Z

@kruskall can we also remove the use of "github.com/pkg/errors"?

That's not possible:

beats/x-pack/libbeat/common/cloudfoundry/cache.go

Line 14 in 1e94259

    
           "github.com/pkg/errors" //nolint:gomodguard // go-cfclient uses pkg/errors internally, must be upgraded to at least https://github.com/cloudfoundry-community/go-cfclient/commit/0ada4e9452

auditbeat/module/auditd/config.go

auditbeat/module/file_integrity/config_test.go

efd6 · 2024-09-30T21:33:21Z

libbeat/common/schema/mapstriface/mapstriface.go

-				err.SetKey(convMap.Key + "." + err.Key())
+		_, errs := convMap.Schema.ApplyTo(subEvent, subData.(map[string]interface{}))
+		for _, err := range errs {
+			var keyErr schema.KeyError


This is surprising. It would be made less so if there were a comment explaining that while schema.KeyError doesn't satisfy error, its implementations do.

efd6 · 2024-09-30T21:36:52Z

libbeat/mapping/field_test.go

@@ -536,7 +536,7 @@ func TestFieldConcat(t *testing.T) {
 				{Name: "foo", Fields: Fields{{Name: "b", Fields: Fields{{Name: "c"}}}}},
 			},

-			err: "2 errors: fields contain key <a>; fields contain non object node conflicting with key <foo.b.c>",
+			err: "fields contain key <a>\nfields contain non object node conflicting with key <foo.b.c>",


I was wondering about this. How does this impact on error rendering to users? I suspect it would be and improvement, but it's worth checking.

metricbeat/module/jolokia/jmx/data.go

x-pack/auditbeat/module/system/socket/helper/loopback.go

x-pack/functionbeat/function/core/coordinator.go

efd6 · 2024-09-30T21:52:25Z

x-pack/libbeat/management/managerV2.go

+		// reloadInputs wraps the multierror so we have to call Unwrap
+		wr := errors.Unwrap(err)
+
+		//nolint:errorlint // ignore


What is it complaining about here?

x-pack/libbeat/management/managerV2.go

Co-authored-by: Dan Kortschak <[email protected]>

efd6 · 2024-10-01T03:19:38Z

x-pack/auditbeat/module/system/socket/helper/loopback.go

@@ -108,8 +108,7 @@ func (lo *IPv6Loopback) AddRandomAddress() (addr net.IP, err error) {
 		if err = unix.Bind(fd, &bindAddr); err == nil {
 			break
 		}
-		//nolint:errorlint // ignore
-		if errno, ok := err.(unix.Errno); !ok || errno != unix.EADDRNOTAVAIL {
+		if !errors.Is(err, unix.EADDRNOTAVAIL) {


:old-man-shouting-at-clouds: x/sys/unix has two instances of %w (both in code generators rather than lib code) and AFAICS no other form of error wrapping (it would be very strange if a package that sits at this level of the stack did). While not bound by go1compat or semver, it would be extremely surprising if this ever changed since code is copied from x/sys/unix into the std tree. But if it keeps people happy…

feat: replace multierror with stdlib errors wrapping

fef0a58

replace multierror library with stdlib error wrapping

kruskall added the enhancement label Sep 29, 2024

botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Sep 29, 2024

mergify bot assigned kruskall Sep 29, 2024

mergify bot added the backport-8.x Automated backport to the 8.x branch with mergify label Sep 29, 2024

kruskall added 11 commits September 30, 2024 00:47

lint: fix linting issues

3f9dd7f

lint: regenerate notice file

6e3cc29

lint: fix linting issues

8d389db

lint: fix linting issues

6053d69

lint: fix linting issues

4b9416c

lint: fix linting issues

6214d97

lint: fix linting issues

1511c5e

lint: fix linting issues

54c663f

lint: fix linting issues

c5a3b9a

lint: fix linting issues

712d258

lint: fix linting issues

eacde97

kruskall marked this pull request as ready for review September 30, 2024 09:43

kruskall requested review from a team as code owners September 30, 2024 09:43

kruskall requested review from faec and VihasMakwana September 30, 2024 09:43

pierrehilbert added Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team Team:Security-Linux Platform Linux Platform Team in Security Solution Team:Security-Windows Platform Windows Platform Team in Security Solution Team:Monitoring Stack Monitoring team labels Sep 30, 2024

botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Sep 30, 2024

Merge branch 'main' into feat/drop-multierror

88f930b

efd6 reviewed Sep 30, 2024

View reviewed changes

kruskall and others added 6 commits October 1, 2024 05:01

Update auditbeat/module/auditd/config.go

b3f3c10

Co-authored-by: Dan Kortschak <[email protected]>

Update auditbeat/module/file_integrity/config_test.go

6c92592

Co-authored-by: Dan Kortschak <[email protected]>

lint: merge lines

ac27fd4

lint: fix linter issues

777fada

lint: fix linter issues

0437395

lint: fix linter issues

794432e

efd6 reviewed Oct 1, 2024

View reviewed changes

kruskall added 5 commits October 7, 2024 01:56

Merge branch 'main' into feat/drop-multierror

d6debe0

lint: rename errs variable

c84a4bc

fix: update wrapping format

f429777

lint: go mod tidy

c686027

Merge branch 'main' into feat/drop-multierror

a5717bb

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: replace multierror with stdlib errors wrapping #41043

feat: replace multierror with stdlib errors wrapping #41043

kruskall commented Sep 29, 2024

mergify bot commented Sep 29, 2024

mergify bot commented Sep 29, 2024

shmsr commented Sep 30, 2024

elasticmachine commented Sep 30, 2024

elasticmachine commented Sep 30, 2024

elasticmachine commented Sep 30, 2024

mergify bot commented Sep 30, 2024

kruskall commented Sep 30, 2024

efd6 Sep 30, 2024

efd6 Sep 30, 2024

efd6 Sep 30, 2024

efd6 Oct 1, 2024

feat: replace multierror with stdlib errors wrapping #41043

Are you sure you want to change the base?

feat: replace multierror with stdlib errors wrapping #41043

Conversation

kruskall commented Sep 29, 2024

Proposed commit message

Checklist

Disruptive User Impact

Author's Checklist

How to test this PR locally

Related issues

Use cases

Screenshots

Logs

mergify bot commented Sep 29, 2024

mergify bot commented Sep 29, 2024

shmsr commented Sep 30, 2024

elasticmachine commented Sep 30, 2024

elasticmachine commented Sep 30, 2024

elasticmachine commented Sep 30, 2024

mergify bot commented Sep 30, 2024

kruskall commented Sep 30, 2024

efd6 Sep 30, 2024

Choose a reason for hiding this comment

efd6 Sep 30, 2024

Choose a reason for hiding this comment

efd6 Sep 30, 2024

Choose a reason for hiding this comment

efd6 Oct 1, 2024

Choose a reason for hiding this comment