Move CombineErrors to consumererror package (#2442)

bogdandrutu · web-flow · commit 5cc0707e8a29 · 2021-02-12T15:13:01.000-08:00
Signed-off-by: Bogdan Drutu &lt;bogdandrutu@gmail.com&gt;
diff --git a/component/componenterror/errors.go b/component/componenterror/errors.go
@@ -18,8 +18,6 @@ package componenterror
 
 import (
 	"errors"
-	"fmt"
-	"strings"
 
 	"go.opentelemetry.io/collector/consumer/consumererror"
 )
@@ -36,28 +34,7 @@ var (
 )
 
 // CombineErrors converts a list of errors into one error.
+// Deprecated: use consumererror.CombineErrors instead.
 func CombineErrors(errs []error) error {
-	numErrors := len(errs)
-	if numErrors == 0 {
-		// No errors
-		return nil
-	}
-
-	if numErrors == 1 {
-		return errs[0]
-	}
-
-	errMsgs := make([]string, 0, numErrors)
-	permanent := false
-	for _, err := range errs {
-		if !permanent && consumererror.IsPermanent(err) {
-			permanent = true
-		}
-		errMsgs = append(errMsgs, err.Error())
-	}
-	err := fmt.Errorf("[%s]", strings.Join(errMsgs, "; "))
-	if permanent {
-		err = consumererror.Permanent(err)
-	}
-	return err
+	return consumererror.CombineErrors(errs)
 }
diff --git a/config/configcheck/configcheck.go b/config/configcheck/configcheck.go
@@ -25,7 +25,7 @@ import (
 	"strings"
 
 	"go.opentelemetry.io/collector/component"
-	"go.opentelemetry.io/collector/component/componenterror"
+	"go.opentelemetry.io/collector/consumer/consumererror"
 )
 
 // The regular expression for valid config field tag.
@@ -56,7 +56,7 @@ func ValidateConfigFromFactories(factories component.Factories) error {
 		}
 	}
 
-	return componenterror.CombineErrors(errs)
+	return consumererror.CombineErrors(errs)
 }
 
 // ValidateConfig enforces that given configuration object is following the patterns
@@ -109,7 +109,7 @@ func validateConfigDataType(t reflect.Type) error {
 		// reflect.UnsafePointer.
 	}
 
-	if err := componenterror.CombineErrors(errs); err != nil {
+	if err := consumererror.CombineErrors(errs); err != nil {
 		return fmt.Errorf(
 			"type %q from package %q has invalid config settings: %v",
 			t.Name(),
diff --git a/consumer/consumererror/combineerrors.go b/consumer/consumererror/combineerrors.go
@@ -0,0 +1,47 @@
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package consumererror
+
+import (
+	"fmt"
+	"strings"
+)
+
+// CombineErrors converts a list of errors into one error.
+func CombineErrors(errs []error) error {
+	numErrors := len(errs)
+	if numErrors == 0 {
+		// No errors
+		return nil
+	}
+
+	if numErrors == 1 {
+		return errs[0]
+	}
+
+	errMsgs := make([]string, 0, numErrors)
+	permanent := false
+	for _, err := range errs {
+		if !permanent && IsPermanent(err) {
+			permanent = true
+		}
+		errMsgs = append(errMsgs, err.Error())
+	}
+	err := fmt.Errorf("[%s]", strings.Join(errMsgs, "; "))
+	if permanent {
+		err = Permanent(err)
+	}
+	return err
+}
diff --git a/consumer/consumererror/combineerrors_test.go b/consumer/consumererror/combineerrors_test.go
@@ -12,14 +12,11 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package componenterror_test
+package consumererror
 
 import (
 	"fmt"
 	"testing"
-
-	"go.opentelemetry.io/collector/component/componenterror"
-	"go.opentelemetry.io/collector/consumer/consumererror"
 )
 
 func TestCombineErrors(t *testing.T) {
@@ -50,20 +47,20 @@ func TestCombineErrors(t *testing.T) {
 			errors: []error{
 				fmt.Errorf("foo"),
 				fmt.Errorf("bar"),
-				consumererror.Permanent(fmt.Errorf("permanent"))},
+				Permanent(fmt.Errorf("permanent"))},
 			expected: "Permanent error: [foo; bar; Permanent error: permanent]",
 		},
 	}
 
 	for _, tc := range testCases {
-		got := componenterror.CombineErrors(tc.errors)
+		got := CombineErrors(tc.errors)
 		if (got == nil) != tc.expectNil {
 			t.Errorf("CombineErrors(%v) == nil? Got: %t. Want: %t", tc.errors, got == nil, tc.expectNil)
 		}
 		if got != nil && tc.expected != got.Error() {
 			t.Errorf("CombineErrors(%v) = %q. Want: %q", tc.errors, got, tc.expected)
 		}
-		if tc.expectedPermanent && !consumererror.IsPermanent(got) {
+		if tc.expectedPermanent && !IsPermanent(got) {
 			t.Errorf("CombineErrors(%v) = %q. Want: consumererror.permanent", tc.errors, got)
 		}
 	}
diff --git a/exporter/kafkaexporter/jaeger_marshaller.go b/exporter/kafkaexporter/jaeger_marshaller.go
@@ -20,7 +20,7 @@ import (
 	"github.com/gogo/protobuf/jsonpb"
 	jaegerproto "github.com/jaegertracing/jaeger/model"
 
-	"go.opentelemetry.io/collector/component/componenterror"
+	"go.opentelemetry.io/collector/consumer/consumererror"
 	"go.opentelemetry.io/collector/consumer/pdata"
 	jaegertranslator "go.opentelemetry.io/collector/translator/trace/jaeger"
 )
@@ -50,7 +50,7 @@ func (j jaegerMarshaller) Marshal(traces pdata.Traces) ([]Message, error) {
 			messages = append(messages, Message{Value: bts})
 		}
 	}
-	return messages, componenterror.CombineErrors(errs)
+	return messages, consumererror.CombineErrors(errs)
 }
 
 func (j jaegerMarshaller) Encoding() string {
diff --git a/exporter/prometheusremotewriteexporter/exporter.go b/exporter/prometheusremotewriteexporter/exporter.go
@@ -31,7 +31,6 @@ import (
 	"github.com/golang/snappy"
 	"github.com/prometheus/prometheus/prompb"
 
-	"go.opentelemetry.io/collector/component/componenterror"
 	"go.opentelemetry.io/collector/consumer/consumererror"
 	"go.opentelemetry.io/collector/consumer/pdata"
 	otlp "go.opentelemetry.io/collector/internal/data/protogen/metrics/v1"
@@ -155,7 +154,7 @@ func (prwe *PrwExporter) PushMetrics(ctx context.Context, md pdata.Metrics) (int
 		}
 
 		if dropped != 0 {
-			return dropped, componenterror.CombineErrors(errs)
+			return dropped, consumererror.CombineErrors(errs)
 		}
 
 		return 0, nil
diff --git a/processor/cloningfanoutconnector.go b/processor/cloningfanoutconnector.go
@@ -17,8 +17,8 @@ package processor
 import (
 	"context"
 
-	"go.opentelemetry.io/collector/component/componenterror"
 	"go.opentelemetry.io/collector/consumer"
+	"go.opentelemetry.io/collector/consumer/consumererror"
 	"go.opentelemetry.io/collector/consumer/pdata"
 )
 
@@ -61,7 +61,7 @@ func (mfc metricsCloningFanOutConnector) ConsumeMetrics(ctx context.Context, md
 		}
 	}
 
-	return componenterror.CombineErrors(errs)
+	return consumererror.CombineErrors(errs)
 }
 
 // NewTracesCloningFanOutConnector wraps multiple traces consumers in a single one and clones the data
@@ -98,7 +98,7 @@ func (tfc tracesCloningFanOutConnector) ConsumeTraces(ctx context.Context, td pd
 		}
 	}
 
-	return componenterror.CombineErrors(errs)
+	return consumererror.CombineErrors(errs)
 }
 
 // NewLogsCloningFanOutConnector wraps multiple trace consumers in a single one.
@@ -134,5 +134,5 @@ func (lfc logsCloningFanOutConnector) ConsumeLogs(ctx context.Context, ld pdata.
 		}
 	}
 
-	return componenterror.CombineErrors(errs)
+	return consumererror.CombineErrors(errs)
 }
diff --git a/processor/fanoutconnector.go b/processor/fanoutconnector.go
@@ -17,8 +17,8 @@ package processor
 import (
 	"context"
 
-	"go.opentelemetry.io/collector/component/componenterror"
 	"go.opentelemetry.io/collector/consumer"
+	"go.opentelemetry.io/collector/consumer/consumererror"
 	"go.opentelemetry.io/collector/consumer/pdata"
 )
 
@@ -46,7 +46,7 @@ func (mfc metricsFanOutConnector) ConsumeMetrics(ctx context.Context, md pdata.M
 			errs = append(errs, err)
 		}
 	}
-	return componenterror.CombineErrors(errs)
+	return consumererror.CombineErrors(errs)
 }
 
 // NewTracesFanOutConnector wraps multiple trace consumers in a single one.
@@ -70,7 +70,7 @@ func (tfc traceFanOutConnector) ConsumeTraces(ctx context.Context, td pdata.Trac
 			errs = append(errs, err)
 		}
 	}
-	return componenterror.CombineErrors(errs)
+	return consumererror.CombineErrors(errs)
 }
 
 // NewLogsFanOutConnector wraps multiple log consumers in a single one.
@@ -94,5 +94,5 @@ func (fc logsFanOutConnector) ConsumeLogs(ctx context.Context, ld pdata.Logs) er
 			errs = append(errs, err)
 		}
 	}
-	return componenterror.CombineErrors(errs)
+	return consumererror.CombineErrors(errs)
 }
diff --git a/receiver/jaegerreceiver/trace_receiver.go b/receiver/jaegerreceiver/trace_receiver.go
@@ -49,6 +49,7 @@ import (
 	"go.opentelemetry.io/collector/component/componenterror"
 	"go.opentelemetry.io/collector/config/configgrpc"
 	"go.opentelemetry.io/collector/consumer"
+	"go.opentelemetry.io/collector/consumer/consumererror"
 	"go.opentelemetry.io/collector/obsreport"
 	jaegertranslator "go.opentelemetry.io/collector/translator/trace/jaeger"
 )
@@ -233,7 +234,7 @@ func (jr *jReceiver) Shutdown(context.Context) error {
 			jr.grpc.Stop()
 			jr.grpc = nil
 		}
-		err = componenterror.CombineErrors(errs)
+		err = consumererror.CombineErrors(errs)
 	})
 
 	return err
diff --git a/receiver/scraperhelper/errors.go b/receiver/scraperhelper/errors.go
@@ -19,7 +19,6 @@ import (
 	"fmt"
 	"strings"
 
-	"go.opentelemetry.io/collector/component/componenterror"
 	"go.opentelemetry.io/collector/consumer/consumererror"
 )
 
@@ -35,7 +34,7 @@ func CombineScrapeErrors(errs []error) error {
 	}
 
 	if !partialScrapeErr {
-		return componenterror.CombineErrors(errs)
+		return consumererror.CombineErrors(errs)
 	}
 
 	errMsgs := make([]string, 0, len(errs))
diff --git a/receiver/scraperhelper/scrapercontroller.go b/receiver/scraperhelper/scrapercontroller.go
@@ -165,7 +165,7 @@ func (sc *controller) Shutdown(ctx context.Context) error {
 			errs = append(errs, err)
 		}
 	}
-	return componenterror.CombineErrors(errs)
+	return consumererror.CombineErrors(errs)
 }
 
 // startScraping initiates a ticker that calls Scrape based on the configured
@@ -249,7 +249,7 @@ func (mms *multiMetricScraper) Shutdown(ctx context.Context) error {
 			errs = append(errs, err)
 		}
 	}
-	return componenterror.CombineErrors(errs)
+	return consumererror.CombineErrors(errs)
 }
 
 func (mms *multiMetricScraper) Scrape(ctx context.Context, receiverName string) (pdata.ResourceMetricsSlice, error) {
diff --git a/receiver/scraperhelper/scrapercontroller_test.go b/receiver/scraperhelper/scrapercontroller_test.go
@@ -27,7 +27,6 @@ import (
 	"go.uber.org/zap"
 
 	"go.opentelemetry.io/collector/component"
-	"go.opentelemetry.io/collector/component/componenterror"
 	"go.opentelemetry.io/collector/component/componenttest"
 	"go.opentelemetry.io/collector/consumer"
 	"go.opentelemetry.io/collector/consumer/consumererror"
@@ -327,7 +326,7 @@ func getExpectedShutdownErr(test metricsTestCase) error {
 		}
 	}
 
-	return componenterror.CombineErrors(errs)
+	return consumererror.CombineErrors(errs)
 }
 
 func assertChannelsCalled(t *testing.T, chs []chan bool, message string) {
diff --git a/service/builder/exporters_builder.go b/service/builder/exporters_builder.go
@@ -21,9 +21,9 @@ import (
 	"go.uber.org/zap"
 
 	"go.opentelemetry.io/collector/component"
-	"go.opentelemetry.io/collector/component/componenterror"
 	"go.opentelemetry.io/collector/config/configerror"
 	"go.opentelemetry.io/collector/config/configmodels"
+	"go.opentelemetry.io/collector/consumer/consumererror"
 )
 
 // builtExporter is an exporter that is built based on a config. It can have
@@ -43,7 +43,7 @@ func (bexp *builtExporter) Start(ctx context.Context, host component.Host) error
 		}
 	}
 
-	return componenterror.CombineErrors(errors)
+	return consumererror.CombineErrors(errors)
 }
 
 // Shutdown the trace component and the metrics component of an exporter.
@@ -56,7 +56,7 @@ func (bexp *builtExporter) Shutdown(ctx context.Context) error {
 		}
 	}
 
-	return componenterror.CombineErrors(errors)
+	return consumererror.CombineErrors(errors)
 }
 
 func (bexp *builtExporter) getTraceExporter() component.TracesExporter {
@@ -109,7 +109,7 @@ func (exps Exporters) ShutdownAll(ctx context.Context) error {
 		}
 	}
 
-	return componenterror.CombineErrors(errs)
+	return consumererror.CombineErrors(errs)
 }
 
 func (exps Exporters) ToMapByDataType() map[configmodels.DataType]map[configmodels.Exporter]component.Exporter {
diff --git a/service/builder/extensions_builder.go b/service/builder/extensions_builder.go
@@ -21,8 +21,8 @@ import (
 	"go.uber.org/zap"
 
 	"go.opentelemetry.io/collector/component"
-	"go.opentelemetry.io/collector/component/componenterror"
 	"go.opentelemetry.io/collector/config/configmodels"
+	"go.opentelemetry.io/collector/consumer/consumererror"
 )
 
 // builtExporter is an exporter that is built based on a config. It can have
@@ -71,7 +71,7 @@ func (exts Extensions) ShutdownAll(ctx context.Context) error {
 		}
 	}
 
-	return componenterror.CombineErrors(errs)
+	return consumererror.CombineErrors(errs)
 }
 
 func (exts Extensions) NotifyPipelineReady() error {
@@ -99,7 +99,7 @@ func (exts Extensions) NotifyPipelineNotReady() error {
 		}
 	}
 
-	return componenterror.CombineErrors(errs)
+	return consumererror.CombineErrors(errs)
 }
 
 func (exts Extensions) ToMap() map[configmodels.Extension]component.ServiceExtension {
diff --git a/service/builder/pipelines_builder.go b/service/builder/pipelines_builder.go
diff --git a/service/builder/receivers_builder.go b/service/builder/receivers_builder.go
diff --git a/service/defaultcomponents/defaults.go b/service/defaultcomponents/defaults.go
diff --git a/service/service.go b/service/service.go

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ import (`
`25`	`25`	`"strings"`
`26`	`26`
`27`	`27`	`"go.opentelemetry.io/collector/component"`
`28`		`- "go.opentelemetry.io/collector/component/componenterror"`
	`28`	`+ "go.opentelemetry.io/collector/consumer/consumererror"`
`29`	`29`	`)`
`30`	`30`
`31`	`31`	`// The regular expression for valid config field tag.`
`@@ -56,7 +56,7 @@ func ValidateConfigFromFactories(factories component.Factories) error {`
`56`	`56`	`}`
`57`	`57`	`}`
`58`	`58`
`59`		`- return componenterror.CombineErrors(errs)`
	`59`	`+ return consumererror.CombineErrors(errs)`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`// ValidateConfig enforces that given configuration object is following the patterns`
`@@ -109,7 +109,7 @@ func validateConfigDataType(t reflect.Type) error {`
`109`	`109`	`// reflect.UnsafePointer.`
`110`	`110`	`}`
`111`	`111`
`112`		`- if err := componenterror.CombineErrors(errs); err != nil {`
	`112`	`+ if err := consumererror.CombineErrors(errs); err != nil {`
`113`	`113`	`return fmt.Errorf(`
`114`	`114`	`"type %q from package %q has invalid config settings: %v",`
`115`	`115`	`t.Name(),`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ import (`
`20`	`20`	`"github.com/gogo/protobuf/jsonpb"`
`21`	`21`	`jaegerproto "github.com/jaegertracing/jaeger/model"`
`22`	`22`
`23`		`- "go.opentelemetry.io/collector/component/componenterror"`
	`23`	`+ "go.opentelemetry.io/collector/consumer/consumererror"`
`24`	`24`	`"go.opentelemetry.io/collector/consumer/pdata"`
`25`	`25`	`jaegertranslator "go.opentelemetry.io/collector/translator/trace/jaeger"`
`26`	`26`	`)`
`@@ -50,7 +50,7 @@ func (j jaegerMarshaller) Marshal(traces pdata.Traces) ([]Message, error) {`
`50`	`50`	`messages = append(messages, Message{Value: bts})`
`51`	`51`	`}`
`52`	`52`	`}`
`53`		`- return messages, componenterror.CombineErrors(errs)`
	`53`	`+ return messages, consumererror.CombineErrors(errs)`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`func (j jaegerMarshaller) Encoding() string {`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,6 @@ import (`
`31`	`31`	`"github.com/golang/snappy"`
`32`	`32`	`"github.com/prometheus/prometheus/prompb"`
`33`	`33`
`34`		`- "go.opentelemetry.io/collector/component/componenterror"`
`35`	`34`	`"go.opentelemetry.io/collector/consumer/consumererror"`
`36`	`35`	`"go.opentelemetry.io/collector/consumer/pdata"`
`37`	`36`	`otlp "go.opentelemetry.io/collector/internal/data/protogen/metrics/v1"`
`@@ -155,7 +154,7 @@ func (prwe *PrwExporter) PushMetrics(ctx context.Context, md pdata.Metrics) (int`
`155`	`154`	`}`
`156`	`155`
`157`	`156`	`if dropped != 0 {`
`158`		`- return dropped, componenterror.CombineErrors(errs)`
	`157`	`+ return dropped, consumererror.CombineErrors(errs)`
`159`	`158`	`}`
`160`	`159`
`161`	`160`	`return 0, nil`
Original file line number	Diff line number	Diff line change
`@@ -17,8 +17,8 @@ package processor`
`17`	`17`	`import (`
`18`	`18`	`"context"`
`19`	`19`
`20`		`- "go.opentelemetry.io/collector/component/componenterror"`
`21`	`20`	`"go.opentelemetry.io/collector/consumer"`
	`21`	`+ "go.opentelemetry.io/collector/consumer/consumererror"`
`22`	`22`	`"go.opentelemetry.io/collector/consumer/pdata"`
`23`	`23`	`)`
`24`	`24`
`@@ -61,7 +61,7 @@ func (mfc metricsCloningFanOutConnector) ConsumeMetrics(ctx context.Context, md`
`61`	`61`	`}`
`62`	`62`	`}`
`63`	`63`
`64`		`- return componenterror.CombineErrors(errs)`
	`64`	`+ return consumererror.CombineErrors(errs)`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`// NewTracesCloningFanOutConnector wraps multiple traces consumers in a single one and clones the data`
`@@ -98,7 +98,7 @@ func (tfc tracesCloningFanOutConnector) ConsumeTraces(ctx context.Context, td pd`
`98`	`98`	`}`
`99`	`99`	`}`
`100`	`100`
`101`		`- return componenterror.CombineErrors(errs)`
	`101`	`+ return consumererror.CombineErrors(errs)`
`102`	`102`	`}`
`103`	`103`
`104`	`104`	`// NewLogsCloningFanOutConnector wraps multiple trace consumers in a single one.`
`@@ -134,5 +134,5 @@ func (lfc logsCloningFanOutConnector) ConsumeLogs(ctx context.Context, ld pdata.`
`134`	`134`	`}`
`135`	`135`	`}`
`136`	`136`
`137`		`- return componenterror.CombineErrors(errs)`
	`137`	`+ return consumererror.CombineErrors(errs)`
`138`	`138`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,6 @@ import (`
`19`	`19`	`"fmt"`
`20`	`20`	`"strings"`
`21`	`21`
`22`		`- "go.opentelemetry.io/collector/component/componenterror"`
`23`	`22`	`"go.opentelemetry.io/collector/consumer/consumererror"`
`24`	`23`	`)`
`25`	`24`
`@@ -35,7 +34,7 @@ func CombineScrapeErrors(errs []error) error {`
`35`	`34`	`}`
`36`	`35`
`37`	`36`	`if !partialScrapeErr {`
`38`		`- return componenterror.CombineErrors(errs)`
	`37`	`+ return consumererror.CombineErrors(errs)`
`39`	`38`	`}`
`40`	`39`
`41`	`40`	`errMsgs := make([]string, 0, len(errs))`