From f43678235d7245fec7473f4ace652a5e849c2884 Mon Sep 17 00:00:00 2001
From: Dominic Evans <dominic.evans@uk.ibm.com>
Date: Sun, 27 Feb 2022 10:56:49 +0000
Subject: [PATCH] fix: reduce verbosity and whitespace of multierror

Add a customised default implementation of the multierror format func
that is less verbose for single error multierrors (return them without
the unnecessary "1 error occured:" prefix) and also condenses the output
by removing one of the newline separators from between multiple errors
in the output.
---
 errors.go      | 20 ++++++++++++++++++--
 errors_test.go |  4 ++--
 2 files changed, 20 insertions(+), 4 deletions(-)

diff --git a/errors.go b/errors.go
index ba27d38b3..507002bfa 100644
--- a/errors.go
+++ b/errors.go
@@ -3,6 +3,7 @@ package sarama
 import (
 	"errors"
 	"fmt"
+	"strings"
 
 	"github.com/hashicorp/go-multierror"
 )
@@ -63,8 +64,23 @@ var ErrReassignPartitions = errors.New("failed to reassign partitions for topic"
 // ErrDeleteRecords is the type of error returned when fail to delete the required records
 var ErrDeleteRecords = errors.New("kafka server: failed to delete records")
 
-// The formatter used to format multierrors
-var MultiErrorFormat multierror.ErrorFormatFunc
+// MultiErrorFormat specifies the formatter applied to format multierrors. The
+// default implementation is a consensed version of the hashicorp/go-multierror
+// default one
+var MultiErrorFormat multierror.ErrorFormatFunc = func(es []error) string {
+	if len(es) == 1 {
+		return es[0].Error()
+	}
+
+	points := make([]string, len(es))
+	for i, err := range es {
+		points[i] = fmt.Sprintf("* %s", err)
+	}
+
+	return fmt.Sprintf(
+		"%d errors occurred:\n\t%s\n",
+		len(es), strings.Join(points, "\n\t"))
+}
 
 type sentinelError struct {
 	sentinel error
diff --git a/errors_test.go b/errors_test.go
index d10649b80..4efdd9d4e 100644
--- a/errors_test.go
+++ b/errors_test.go
@@ -7,12 +7,12 @@ import (
 	"testing"
 )
 
-func TestSentinelWithWrappedError(t *testing.T) {
+func TestSentinelWithSingleWrappedError(t *testing.T) {
 	t.Parallel()
 	myNetError := &net.OpError{Op: "mock", Err: errors.New("op error")}
 	error := Wrap(ErrOutOfBrokers, myNetError)
 
-	expected := fmt.Sprintf("%s: 1 error occurred:\n\t* %s\n\n", ErrOutOfBrokers, myNetError)
+	expected := fmt.Sprintf("%s: %s", ErrOutOfBrokers, myNetError)
 	actual := error.Error()
 	if actual != expected {
 		t.Errorf("unexpected value '%s' vs '%v'", expected, actual)