refactor: replace go-multierror with stdlib go multierrors (#5240)

* refactor: replace go-multierror with stdlib go multierrors

replace go-multierror with stdlib errors.Join

* lint: fix linter issues

Author: kruskall

NOTICE.txt

@@ -30,7 +30,6 @@ require (
 	github.com/google/go-cmp v0.6.0
 	github.com/google/pprof v0.0.0-20240528025155-186aa0362fba
 	github.com/gorilla/mux v1.8.1
-	github.com/hashicorp/go-multierror v1.1.1
 	github.com/hectane/go-acl v0.0.0-20190604041725-da78bae5fc95
 	github.com/jaypipes/ghw v0.12.0
 	github.com/jedib0t/go-pretty/v6 v6.4.6
@@ -216,6 +215,7 @@ require (
 	github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
 	github.com/hashicorp/go-hclog v1.6.3 // indirect
 	github.com/hashicorp/go-immutable-radix v1.3.1 // indirect
+	github.com/hashicorp/go-multierror v1.1.1 // indirect
 	github.com/hashicorp/go-retryablehttp v0.7.7 // indirect
 	github.com/hashicorp/go-rootcerts v1.0.2 // indirect
 	github.com/hashicorp/golang-lru v1.0.2 // indirect

go.mod

@@ -13,8 +13,6 @@ import (
 	"sync/atomic"
 	"time"
 
-	"github.com/hashicorp/go-multierror"
-
 	"go.elastic.co/apm/v2"
 	"gopkg.in/yaml.v2"
 
@@ -1571,7 +1569,7 @@ func collectManagerErrors(timeout time.Duration, varsErrCh, runtimeErrCh, config
 
 	// combinedErr will store any reported errors as well as timeout errors
 	// for unresponsive managers.
-	var combinedErr error
+	var errs []error
 
 waitLoop:
 	for !returnedRuntime || !returnedConfig || !returnedVars || !returnedUpgradeMarkerWatcher {
@@ -1599,23 +1597,23 @@ waitLoop:
 				timeouts = append(timeouts, "no response from upgrade marker watcher")
 			}
 			timeoutStr := strings.Join(timeouts, ", ")
-			combinedErr = multierror.Append(combinedErr, fmt.Errorf("timeout while waiting for managers to shut down: %v", timeoutStr))
+			errs = append(errs, fmt.Errorf("timeout while waiting for managers to shut down: %v", timeoutStr))
 			break waitLoop
 		}
 	}
 	if runtimeErr != nil && !errors.Is(runtimeErr, context.Canceled) {
-		combinedErr = multierror.Append(combinedErr, fmt.Errorf("runtime manager: %w", runtimeErr))
+		errs = append(errs, fmt.Errorf("runtime manager: %w", runtimeErr))
 	}
 	if configErr != nil && !errors.Is(configErr, context.Canceled) {
-		combinedErr = multierror.Append(combinedErr, fmt.Errorf("config manager: %w", configErr))
+		errs = append(errs, fmt.Errorf("config manager: %w", configErr))
 	}
 	if varsErr != nil && !errors.Is(varsErr, context.Canceled) {
-		combinedErr = multierror.Append(combinedErr, fmt.Errorf("vars manager: %w", varsErr))
+		errs = append(errs, fmt.Errorf("vars manager: %w", varsErr))
 	}
 	if upgradeMarkerWatcherErr != nil && !errors.Is(upgradeMarkerWatcherErr, context.Canceled) {
-		combinedErr = multierror.Append(combinedErr, fmt.Errorf("upgrade marker watcher: %w", upgradeMarkerWatcherErr))
+		errs = append(errs, fmt.Errorf("upgrade marker watcher: %w", upgradeMarkerWatcherErr))
 	}
-	return combinedErr
+	return errors.Join(errs...)
 }
 
 type coordinatorComponentLog struct {

internal/pkg/agent/application/coordinator/coordinator.go

@@ -658,7 +658,6 @@ func TestCollectManagerErrorsTimeout(t *testing.T) {
 	// in collectManagerErrors
 	waitAndTestError(t, func(err error) bool {
 		return err != nil &&
-			strings.Contains(err.Error(), "1 error occurred") &&
 			strings.Contains(err.Error(), "timeout while waiting for managers")
 	}, handlerChan)
 }
@@ -673,7 +672,6 @@ func TestCollectManagerErrorsOneResponse(t *testing.T) {
 
 	waitAndTestError(t, func(err error) bool {
 		return err != nil &&
-			strings.Contains(err.Error(), "2 errors occurred") &&
 			strings.Contains(err.Error(), cfgErrStr) &&
 			strings.Contains(err.Error(), "timeout while waiting for managers")
 	}, handlerChan)
@@ -691,7 +689,6 @@ func TestCollectManagerErrorsAllResponses(t *testing.T) {
 
 	waitAndTestError(t, func(err error) bool {
 		return err != nil &&
-			strings.Contains(err.Error(), "3 errors occurred") &&
 			strings.Contains(err.Error(), runtimeErrStr) &&
 			strings.Contains(err.Error(), varsErrStr) &&
 			strings.Contains(err.Error(), upgradeMarkerWatcherErrStr)

internal/pkg/agent/application/coordinator/coordinator_test.go

@@ -6,8 +6,8 @@ package composed
 
 import (
 	"context"
+	goerrors "errors"
 
-	"github.com/hashicorp/go-multierror"
 	"go.elastic.co/apm/v2"
 
 	"github.com/elastic/elastic-agent/internal/pkg/agent/application/upgrade/artifact"
@@ -37,7 +37,7 @@ func NewDownloader(downloaders ...download.Downloader) *Downloader {
 // Download fetches the package from configured source.
 // Returns absolute path to downloaded package and an error.
 func (e *Downloader) Download(ctx context.Context, a artifact.Artifact, version *version.ParsedSemVer) (string, error) {
-	var err error
+	var errs []error
 	span, ctx := apm.StartSpan(ctx, "download", "app.internal")
 	defer span.End()
 
@@ -47,10 +47,10 @@ func (e *Downloader) Download(ctx context.Context, a artifact.Artifact, version
 			return s, nil
 		}
 
-		err = multierror.Append(err, e)
+		errs = append(errs, e)
 	}
 
-	return "", err
+	return "", goerrors.Join(errs...)
 }
 
 func (e *Downloader) Reload(c *artifact.Config) error {

internal/pkg/agent/application/upgrade/artifact/download/composed/downloader.go

@@ -5,7 +5,7 @@
 package composed
 
 import (
-	"github.com/hashicorp/go-multierror"
+	goerrors "errors"
 
 	"github.com/elastic/elastic-agent/internal/pkg/agent/application/upgrade/artifact"
 	"github.com/elastic/elastic-agent/internal/pkg/agent/application/upgrade/artifact/download"
@@ -40,7 +40,7 @@ func NewVerifier(log *logger.Logger, verifiers ...download.Verifier) *Verifier {
 
 // Verify checks the package from configured source.
 func (v *Verifier) Verify(a artifact.Artifact, version agtversion.ParsedSemVer, skipDefaultPgp bool, pgpBytes ...string) error {
-	var err error
+	var errs []error
 
 	for _, verifier := range v.vv {
 		e := verifier.Verify(a, version, skipDefaultPgp, pgpBytes...)
@@ -50,10 +50,10 @@ func (v *Verifier) Verify(a artifact.Artifact, version agtversion.ParsedSemVer,
 		}
 
 		v.log.Debugw("Verifier failed!", "verifier", verifier.Name(), "error", e)
-		err = multierror.Append(err, e)
+		errs = append(errs, e)
 	}
 
-	return err
+	return goerrors.Join(errs...)
 }
 
 func (v *Verifier) Reload(c *artifact.Config) error {

internal/pkg/agent/application/upgrade/artifact/download/composed/verifier.go

@@ -10,6 +10,7 @@ import (
 	"context"
 	"crypto/sha512"
 	"encoding/hex"
+	goerrors "errors"
 	"fmt"
 	"hash"
 	"io"
@@ -20,7 +21,6 @@ import (
 	"strings"
 	"time"
 
-	"github.com/hashicorp/go-multierror"
 	"golang.org/x/crypto/openpgp" //nolint:staticcheck // crypto/openpgp is only receiving security updates.
 
 	"github.com/elastic/elastic-agent/internal/pkg/agent/application/upgrade/artifact"
@@ -309,7 +309,7 @@ func CheckValidDownloadUri(rawURI string) error {
 	}
 
 	if !strings.EqualFold(uri.Scheme, "https") {
-		return multierror.Append(fmt.Errorf("failed to check URI %q: HTTPS is required", rawURI), ErrInvalidLocation)
+		return fmt.Errorf("failed to check URI %q: HTTPS is required: %w", rawURI, ErrInvalidLocation)
 	}
 
 	return nil
@@ -329,7 +329,7 @@ func fetchPgpFromURI(uri string, client HTTPClient) ([]byte, error) {
 	}
 	resp, err := client.Do(req)
 	if err != nil {
-		return nil, multierror.Append(err, ErrRemotePGPDownloadFailed)
+		return nil, goerrors.Join(err, ErrRemotePGPDownloadFailed)
 	}
 	defer resp.Body.Close()
 

internal/pkg/agent/application/upgrade/artifact/download/verifier.go

@@ -5,13 +5,12 @@
 package upgrade
 
 import (
+	"errors"
 	"fmt"
 	"os"
 	"path/filepath"
 	"strings"
 
-	"github.com/hashicorp/go-multierror"
-
 	"github.com/elastic/elastic-agent/internal/pkg/agent/application/paths"
 	"github.com/elastic/elastic-agent/pkg/core/logger"
 )
@@ -30,16 +29,16 @@ func cleanNonMatchingVersionsFromDownloads(log *logger.Logger, version string) e
 	if err != nil {
 		return fmt.Errorf("unable to read directory %q: %w", paths.Downloads(), err)
 	}
-	var rErr error
+	var errs []error
 	for _, file := range files {
 		if file.IsDir() {
 			continue
 		}
 		if !strings.Contains(file.Name(), version) {
 			if err := os.Remove(filepath.Join(paths.Downloads(), file.Name())); err != nil {
-				rErr = multierror.Append(rErr, fmt.Errorf("unable to remove file %q: %w", filepath.Join(paths.Downloads(), file.Name()), err))
+				errs = append(errs, fmt.Errorf("unable to remove file %q: %w", filepath.Join(paths.Downloads(), file.Name()), err))
 			}
 		}
 	}
-	return rErr
+	return errors.Join(errs...)
 }

internal/pkg/agent/application/upgrade/cleanup.go

@@ -6,14 +6,14 @@ package upgrade
 
 import (
 	"context"
+	goerrors "errors"
 	"fmt"
 	"os"
 	"os/exec"
 	"path/filepath"
 	"strings"
 	"time"
 
-	"github.com/hashicorp/go-multierror"
 	"google.golang.org/grpc"
 
 	"github.com/elastic/elastic-agent/internal/pkg/agent/application/paths"
@@ -114,6 +114,7 @@ func Cleanup(log *logger.Logger, topDirPath, currentVersionedHome, currentHash s
 		currentDir = fmt.Sprintf("%s-%s", agentName, currentHash)
 	}
 
+	var errs []error
 	for _, dir := range subdirs {
 		if dir == currentDir {
 			continue
@@ -130,11 +131,11 @@ func Cleanup(log *logger.Logger, topDirPath, currentVersionedHome, currentHash s
 			ignoredDirs = append(ignoredDirs, "logs")
 		}
 		if cleanupErr := install.RemoveBut(hashedDir, true, ignoredDirs...); cleanupErr != nil {
-			err = multierror.Append(err, cleanupErr)
+			errs = append(errs, cleanupErr)
 		}
 	}
 
-	return err
+	return goerrors.Join(errs...)
 }
 
 // InvokeWatcher invokes an agent instance using watcher argument for watching behavior of
@@ -170,6 +171,7 @@ func restartAgent(ctx context.Context, log *logger.Logger, c client.Client) erro
 	restartViaDaemonFn := func(ctx context.Context) error {
 		connectCtx, connectCancel := context.WithTimeout(ctx, 3*time.Second)
 		defer connectCancel()
+		//nolint:staticcheck // requires changing client signature
 		err := c.Connect(connectCtx, grpc.WithBlock(), grpc.WithDisableRetry())
 		if err != nil {
 			return errors.New(err, "failed communicating to running daemon", errors.TypeNetwork, errors.M("socket", control.Address()))

internal/pkg/agent/application/upgrade/rollback.go

@@ -10,7 +10,6 @@ import (
 	"fmt"
 	"time"
 
-	"github.com/hashicorp/go-multierror"
 	"google.golang.org/grpc"
 
 	"github.com/elastic/elastic-agent/pkg/control/v2/client"
@@ -134,6 +133,7 @@ LOOP:
 			// block on connection, don't retry connection, and fail on temp dial errors
 			// always a local connection it should connect quickly so the timeout is only 1 second
 			connectCtx, connectCancel := context.WithTimeout(ctx, 1*time.Second)
+			//nolint:staticcheck // requires changing client signature
 			err := ch.agentClient.Connect(connectCtx, grpc.WithBlock(), grpc.WithDisableRetry(), grpc.FailOnNonTempDialError(true))
 			connectCancel()
 			if err != nil {
@@ -215,14 +215,14 @@ LOOP:
 				} else {
 					// agent is healthy; but a component might not be healthy
 					// upgrade tracks unhealthy component as an issue with the upgrade
-					var compErr error
+					var errs []error
 					for _, comp := range state.Components {
 						if comp.State == client.Failed {
-							compErr = multierror.Append(compErr, fmt.Errorf("component %s[%v] failed: %s", comp.Name, comp.ID, comp.Message))
+							errs = append(errs, fmt.Errorf("component %s[%v] failed: %s", comp.Name, comp.ID, comp.Message))
 						}
 					}
-					if compErr != nil {
-						failedCh <- fmt.Errorf("%w: %w", ErrAgentComponentFailed, compErr)
+					if len(errs) != 0 {
+						failedCh <- fmt.Errorf("%w: %w", ErrAgentComponentFailed, errors.Join(errs...))
 						continue
 					}
 				}

internal/pkg/agent/application/upgrade/watcher.go

@@ -8,9 +8,9 @@ package cmd
 
 import (
 	"context"
+	goerrors "errors"
 	"sync"
 
-	"github.com/hashicorp/go-multierror"
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 
@@ -80,7 +80,7 @@ func runCollector(cmdCtx context.Context, configFiles []string) error {
 	go service.ProcessWindowsControlEvents(stopCollector)
 
 	var otelStartWg sync.WaitGroup
-	var resErr error
+	var errs []error
 	var awaiters awaiters
 
 	otelAwaiter := make(chan struct{})
@@ -90,7 +90,7 @@ func runCollector(cmdCtx context.Context, configFiles []string) error {
 	go func() {
 		otelStartWg.Done()
 		if err := otel.Run(ctx, stop, configFiles); err != nil {
-			resErr = multierror.Append(resErr, err)
+			errs = append(errs, err)
 			// otel collector finished with an error, exit run loop
 			cancel()
 		}
@@ -112,9 +112,9 @@ func runCollector(cmdCtx context.Context, configFiles []string) error {
 		true,     // is otel mode
 		awaiters, // wait for otel to finish
 	); err != nil && !errors.Is(err, context.Canceled) {
-		resErr = multierror.Append(resErr, err)
+		errs = append(errs, err)
 	}
 
-	return resErr
+	return goerrors.Join(errs...)
 
 }

internal/pkg/agent/cmd/otel.go

@@ -9,7 +9,6 @@ import (
 	"fmt"
 
 	"github.com/antlr4-go/antlr/v4"
-	"github.com/hashicorp/go-multierror"
 
 	"github.com/elastic/elastic-agent/internal/pkg/eql/parser"
 )
@@ -108,6 +107,6 @@ func (el *errorListener) SyntaxError(
 	msg string,
 	e antlr.RecognitionException,
 ) {
-	el.errors = multierror.Append(el.errors,
+	el.errors = errors.Join(el.errors,
 		fmt.Errorf("condition line %d column %d: %v", line, column, msg))
 }