refactor: replace urso/sderr with stdlib errors (#39839)

kruskall · web-flow · commit 3c9f4d952bfd · 2024-06-10T23:46:23.000+02:00
* refactor: replace urso/sderr with stdlib errors

Go 1.20 added multiple errors wrapping so we can migrate to stdlib errors and drop
the additional dependency on github.com/urso/sderr

* refactor: avoid wrapping and unwrapping

* Update copytruncate_prospector.go

* Update statestore.go
diff --git a/NOTICE.txt b/NOTICE.txt
diff --git a/filebeat/input/filestream/copytruncate_prospector.go b/filebeat/input/filestream/copytruncate_prospector.go
@@ -18,14 +18,13 @@
 package filestream
 
 import (
+	"errors"
 	"os"
 	"regexp"
 	"sort"
 	"strconv"
 	"time"
 
-	"github.com/urso/sderr"
-
 	loginp "github.com/elastic/beats/v7/filebeat/input/filestream/internal/input-logfile"
 	input "github.com/elastic/beats/v7/filebeat/input/v2"
 	"github.com/elastic/beats/v7/libbeat/common/file"
@@ -230,7 +229,7 @@ func (p *copyTruncateFileProspector) Run(ctx input.Context, s loginp.StateMetada
 
 	errs := tg.Wait()
 	if len(errs) > 0 {
-		log.Error("%s", sderr.WrapAll(errs, "running prospector failed"))
+		log.Errorf("running prospector failed: %v", errors.Join(errs...))
 	}
 }
 
diff --git a/filebeat/input/filestream/internal/input-logfile/manager.go b/filebeat/input/filestream/internal/input-logfile/manager.go
@@ -25,8 +25,6 @@ import (
 	"sync"
 	"time"
 
-	"github.com/urso/sderr"
-
 	"github.com/elastic/go-concert/unison"
 
 	v2 "github.com/elastic/beats/v7/filebeat/input/v2"
@@ -141,7 +139,7 @@ func (cim *InputManager) Init(group unison.Group) error {
 	if err != nil {
 		store.Release()
 		cim.shutdown()
-		return sderr.Wrap(err, "Can not start registry cleanup process")
+		return fmt.Errorf("Can not start registry cleanup process: %w", err)
 	}
 
 	return nil
diff --git a/filebeat/input/filestream/prospector.go b/filebeat/input/filestream/prospector.go
@@ -18,11 +18,10 @@
 package filestream
 
 import (
+	"errors"
 	"fmt"
 	"time"
 
-	"github.com/urso/sderr"
-
 	loginp "github.com/elastic/beats/v7/filebeat/input/filestream/internal/input-logfile"
 	input "github.com/elastic/beats/v7/filebeat/input/v2"
 	"github.com/elastic/beats/v7/libbeat/beat"
@@ -160,7 +159,7 @@ func (p *fileProspector) Run(ctx input.Context, s loginp.StateMetadataUpdater, h
 
 	errs := tg.Wait()
 	if len(errs) > 0 {
-		log.Error("%s", sderr.WrapAll(errs, "running prospector failed"))
+		log.Errorf("running prospector failed: %v", errors.Join(errs...))
 	}
 }
 
diff --git a/filebeat/input/journald/input.go b/filebeat/input/journald/input.go
@@ -20,10 +20,10 @@
 package journald
 
 import (
+	"fmt"
 	"time"
 
 	"github.com/coreos/go-systemd/v22/sdjournal"
-	"github.com/urso/sderr"
 
 	"github.com/elastic/beats/v7/filebeat/input/journald/pkg/journalfield"
 	"github.com/elastic/beats/v7/filebeat/input/journald/pkg/journalread"
@@ -181,7 +181,7 @@ func (inp *journald) open(log *logp.Logger, canceler input.Canceler, src cursor.
 		withTransports(inp.Transports),
 		withSyslogIdentifiers(inp.Identifiers))
 	if err != nil {
-		return nil, sderr.Wrap(err, "failed to create reader for %{path} journal", src.Name())
+		return nil, fmt.Errorf("failed to create reader for %s journal: %w", src.Name(), err)
 	}
 
 	return reader, nil
diff --git a/filebeat/input/journald/pkg/journalread/reader.go b/filebeat/input/journald/pkg/journalread/reader.go
@@ -27,7 +27,6 @@ import (
 	"time"
 
 	"github.com/coreos/go-systemd/v22/sdjournal"
-	"github.com/urso/sderr"
 
 	"github.com/elastic/beats/v7/libbeat/common/backoff"
 	"github.com/elastic/beats/v7/libbeat/common/cleanup"
@@ -96,27 +95,27 @@ func openJournal(path string) (*sdjournal.Journal, error) {
 	if path == localSystemJournalID || path == "" {
 		j, err := sdjournal.NewJournal()
 		if err != nil {
-			err = sderr.Wrap(err, "failed to open local journal")
+			err = fmt.Errorf("failed to open local journal: %w", err)
 		}
 		return j, err
 	}
 
 	stat, err := os.Stat(path)
 	if err != nil {
-		return nil, sderr.Wrap(err, "failed to read meta data for %{path}", path)
+		return nil, fmt.Errorf("failed to read meta data for %s: %w", path, err)
 	}
 
 	if stat.IsDir() {
 		j, err := sdjournal.NewJournalFromDir(path)
 		if err != nil {
-			err = sderr.Wrap(err, "failed to open journal directory %{path}", path)
+			err = fmt.Errorf("failed to open journal directory %s: %w", path, err)
 		}
 		return j, err
 	}
 
 	j, err := sdjournal.NewJournalFromFiles(path)
 	if err != nil {
-		err = sderr.Wrap(err, "failed to open journal file %{path}", path)
+		err = fmt.Errorf("failed to open journal file %s: %w", path, err)
 	}
 	return j, err
 }
diff --git a/filebeat/input/v2/input-cursor/input.go b/filebeat/input/v2/input-cursor/input.go
@@ -19,12 +19,11 @@ package cursor
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"runtime/debug"
 	"time"
 
-	"github.com/urso/sderr"
-
 	"github.com/elastic/go-concert/ctxtool"
 	"github.com/elastic/go-concert/unison"
 
@@ -81,7 +80,7 @@ func (inp *managedInput) Test(ctx input.TestContext) error {
 
 	errs := grp.Wait()
 	if len(errs) > 0 {
-		return sderr.WrapAll(errs, "input tests failed")
+		return fmt.Errorf("input tests failed: %w", errors.Join(errs...))
 	}
 	return nil
 }
@@ -127,7 +126,7 @@ func (inp *managedInput) Run(
 	}
 
 	if errs := grp.Wait(); len(errs) > 0 {
-		return sderr.WrapAll(errs, "input %{id} failed", ctx.ID)
+		return fmt.Errorf("input %s failed: %w", ctx.ID, errors.Join(errs...))
 	}
 	return nil
 }
diff --git a/filebeat/input/v2/input-cursor/manager.go b/filebeat/input/v2/input-cursor/manager.go
@@ -20,11 +20,10 @@ package cursor
 import (
 	"context"
 	"errors"
+	"fmt"
 	"sync"
 	"time"
 
-	"github.com/urso/sderr"
-
 	"github.com/elastic/go-concert/unison"
 
 	v2 "github.com/elastic/beats/v7/filebeat/input/v2"
@@ -131,7 +130,7 @@ func (cim *InputManager) Init(group unison.Group) error {
 	if err != nil {
 		store.Release()
 		cim.shutdown()
-		return sderr.Wrap(err, "Can not start registry cleanup process")
+		return fmt.Errorf("Can not start registry cleanup process: %w", err)
 	}
 
 	return nil
diff --git a/go.mod b/go.mod
@@ -144,7 +144,7 @@ require (
 	github.com/stretchr/testify v1.9.0
 	github.com/tsg/go-daemon v0.0.0-20200207173439-e704b93fd89b
 	github.com/ugorji/go/codec v1.1.8
-	github.com/urso/sderr v0.0.0-20210525210834-52b04e8f5c71
+	github.com/urso/sderr v0.0.0-20210525210834-52b04e8f5c71 // indirect
 	github.com/vmware/govmomi v0.0.0-20170802214208-2cad15190b41
 	github.com/xdg/scram v1.0.3
 	go.elastic.co/ecszap v1.0.2
diff --git a/x-pack/filebeat/input/entityanalytics/provider/azuread/statestore.go b/x-pack/filebeat/input/entityanalytics/provider/azuread/statestore.go
@@ -11,7 +11,6 @@ import (
 	"time"
 
 	"github.com/google/uuid"
-	"github.com/urso/sderr"
 
 	"github.com/elastic/beats/v7/x-pack/filebeat/input/entityanalytics/internal/collections"
 	"github.com/elastic/beats/v7/x-pack/filebeat/input/entityanalytics/internal/kvstore"
@@ -176,7 +175,7 @@ func (s *stateStore) close(commit bool) (err error) {
 		}
 
 		if err != nil {
-			err = sderr.WrapAll([]error{err, rollbackErr}, "multiple errors during statestore close")
+			err = fmt.Errorf("multiple errors during statestore close: %w", errors.Join(err, rollbackErr))
 		} else {
 			err = rollbackErr
 		}
diff --git a/x-pack/filebeat/input/entityanalytics/provider/okta/statestore.go b/x-pack/filebeat/input/entityanalytics/provider/okta/statestore.go
@@ -10,8 +10,6 @@ import (
 	"fmt"
 	"time"
 
-	"github.com/urso/sderr"
-
 	"github.com/elastic/beats/v7/x-pack/filebeat/input/entityanalytics/internal/kvstore"
 	"github.com/elastic/beats/v7/x-pack/filebeat/input/entityanalytics/provider/okta/internal/okta"
 )
@@ -187,10 +185,8 @@ func (s *stateStore) close(commit bool) (err error) {
 			return
 		}
 		rollbackErr := s.tx.Rollback()
-		if rollbackErr == nil {
-			// FIXME: Use fmt.Errorf("multiple errors during statestore close: %w", errors.Join(err, rollbackErr))
-			// when go1.20 is supported.
-			err = sderr.WrapAll([]error{err, rollbackErr}, "multiple errors during statestore close")
+		if rollbackErr != nil {
+			err = fmt.Errorf("multiple errors during statestore close: %w", errors.Join(err, rollbackErr))
 		}
 	}()
 

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,6 @@ import (`
`27`	`27`	`"time"`
`28`	`28`
`29`	`29`	`"github.com/coreos/go-systemd/v22/sdjournal"`
`30`		`- "github.com/urso/sderr"`
`31`	`30`
`32`	`31`	`"github.com/elastic/beats/v7/libbeat/common/backoff"`
`33`	`32`	`"github.com/elastic/beats/v7/libbeat/common/cleanup"`
`@@ -96,27 +95,27 @@ func openJournal(path string) (*sdjournal.Journal, error) {`
`96`	`95`	`if path == localSystemJournalID \|\| path == "" {`
`97`	`96`	`j, err := sdjournal.NewJournal()`
`98`	`97`	`if err != nil {`
`99`		`- err = sderr.Wrap(err, "failed to open local journal")`
	`98`	`+ err = fmt.Errorf("failed to open local journal: %w", err)`
`100`	`99`	`}`
`101`	`100`	`return j, err`
`102`	`101`	`}`
`103`	`102`
`104`	`103`	`stat, err := os.Stat(path)`
`105`	`104`	`if err != nil {`
`106`		`- return nil, sderr.Wrap(err, "failed to read meta data for %{path}", path)`
	`105`	`+ return nil, fmt.Errorf("failed to read meta data for %s: %w", path, err)`
`107`	`106`	`}`
`108`	`107`
`109`	`108`	`if stat.IsDir() {`
`110`	`109`	`j, err := sdjournal.NewJournalFromDir(path)`
`111`	`110`	`if err != nil {`
`112`		`- err = sderr.Wrap(err, "failed to open journal directory %{path}", path)`
	`111`	`+ err = fmt.Errorf("failed to open journal directory %s: %w", path, err)`
`113`	`112`	`}`
`114`	`113`	`return j, err`
`115`	`114`	`}`
`116`	`115`
`117`	`116`	`j, err := sdjournal.NewJournalFromFiles(path)`
`118`	`117`	`if err != nil {`
`119`		`- err = sderr.Wrap(err, "failed to open journal file %{path}", path)`
	`118`	`+ err = fmt.Errorf("failed to open journal file %s: %w", path, err)`
`120`	`119`	`}`
`121`	`120`	`return j, err`
`122`	`121`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,12 +19,11 @@ package cursor`
`19`	`19`
`20`	`20`	`import (`
`21`	`21`	`"context"`
	`22`	`+ "errors"`
`22`	`23`	`"fmt"`
`23`	`24`	`"runtime/debug"`
`24`	`25`	`"time"`
`25`	`26`
`26`		`- "github.com/urso/sderr"`
`27`		`-`
`28`	`27`	`"github.com/elastic/go-concert/ctxtool"`
`29`	`28`	`"github.com/elastic/go-concert/unison"`
`30`	`29`
`@@ -81,7 +80,7 @@ func (inp *managedInput) Test(ctx input.TestContext) error {`
`81`	`80`
`82`	`81`	`errs := grp.Wait()`
`83`	`82`	`if len(errs) > 0 {`
`84`		`- return sderr.WrapAll(errs, "input tests failed")`
	`83`	`+ return fmt.Errorf("input tests failed: %w", errors.Join(errs...))`
`85`	`84`	`}`
`86`	`85`	`return nil`
`87`	`86`	`}`
`@@ -127,7 +126,7 @@ func (inp *managedInput) Run(`
`127`	`126`	`}`
`128`	`127`
`129`	`128`	`if errs := grp.Wait(); len(errs) > 0 {`
`130`		`- return sderr.WrapAll(errs, "input %{id} failed", ctx.ID)`
	`129`	`+ return fmt.Errorf("input %s failed: %w", ctx.ID, errors.Join(errs...))`
`131`	`130`	`}`
`132`	`131`	`return nil`
`133`	`132`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,6 @@ import (`
`11`	`11`	`"time"`
`12`	`12`
`13`	`13`	`"github.com/google/uuid"`
`14`		`- "github.com/urso/sderr"`
`15`	`14`
`16`	`15`	`"github.com/elastic/beats/v7/x-pack/filebeat/input/entityanalytics/internal/collections"`
`17`	`16`	`"github.com/elastic/beats/v7/x-pack/filebeat/input/entityanalytics/internal/kvstore"`
`@@ -176,7 +175,7 @@ func (s *stateStore) close(commit bool) (err error) {`
`176`	`175`	`}`
`177`	`176`
`178`	`177`	`if err != nil {`
`179`		`- err = sderr.WrapAll([]error{err, rollbackErr}, "multiple errors during statestore close")`
	`178`	`+ err = fmt.Errorf("multiple errors during statestore close: %w", errors.Join(err, rollbackErr))`
`180`	`179`	`} else {`
`181`	`180`	`err = rollbackErr`
`182`	`181`	`}`